Package com.openai.models.responses
Class WebSearchTool.Filters
-
- All Implemented Interfaces:
public final class WebSearchTool.FiltersFilters for the search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWebSearchTool.Filters.BuilderA builder for Filters.
-
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 WebSearchTool.Filters.BuildertoBuilder()final WebSearchTool.Filtersvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static WebSearchTool.Filters.Builderbuilder()Returns a mutable builder for constructing an instance of Filters. -
-
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 WebSearchTool.Filters.Builder toBuilder()
-
validate
final WebSearchTool.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.
-
builder
final static WebSearchTool.Filters.Builder builder()
Returns a mutable builder for constructing an instance of Filters.
-
-
-
-