Filters 4.42.0 API

All Implemented Interfaces:


public final class BetaWebSearchTool.Filters

Filters for the search.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaWebSearchTool.Filters.Builder`	A builder for Filters.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<List<String>>`	`allowedDomains()`	Allowed domains for the search.
`final JsonField<List<String>>`	`_allowedDomains()`	Returns the raw JSON value of allowedDomains.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaWebSearchTool.Filters.Builder`	`toBuilder()`
`final BetaWebSearchTool.Filters`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BetaWebSearchTool.Filters.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Filters.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - allowedDomains
```
 final Optional<List<String>> allowedDomains()
```
    Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.
    Example: ["pubmed.ncbi.nlm.nih.gov"]
  - _allowedDomains
```
 final JsonField<List<String>> _allowedDomains()
```
    Returns the raw JSON value of allowedDomains.
    Unlike allowedDomains, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final BetaWebSearchTool.Filters.Builder toBuilder()
```
  - validate
```
 final BetaWebSearchTool.Filters validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BetaWebSearchTool.Filters.Builder builder()
```
    Returns a mutable builder for constructing an instance of Filters.