Class ResponseFunctionWebSearch.Action.Search
-
- All Implemented Interfaces:
public final class ResponseFunctionWebSearch.Action.SearchAction type "search" - Performs a web search query.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseFunctionWebSearch.Action.Search.BuilderA builder for Search.
public final classResponseFunctionWebSearch.Action.Search.SourceA source used in the search.
-
Method Summary
Modifier and Type Method Description final JsonValue_type()The action type. final Optional<List<String>>queries()The search queries. final Optional<String>query()The search query. final Optional<List<ResponseFunctionWebSearch.Action.Search.Source>>sources()The sources used in the search. final JsonField<List<String>>_queries()Returns the raw JSON value of queries. final JsonField<String>_query()Returns the raw JSON value of query. final JsonField<List<ResponseFunctionWebSearch.Action.Search.Source>>_sources()Returns the raw JSON value of sources. final Map<String, JsonValue>_additionalProperties()final ResponseFunctionWebSearch.Action.Search.BuildertoBuilder()final ResponseFunctionWebSearch.Action.Searchvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseFunctionWebSearch.Action.Search.Builderbuilder()Returns a mutable builder for constructing an instance of Search. -
-
Method Detail
-
_type
final JsonValue _type()
The action type.
Expected to always return the following:
JsonValue.from("search")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
query
@Deprecated(message = "deprecated") final Optional<String> query()
The search query.
-
sources
final Optional<List<ResponseFunctionWebSearch.Action.Search.Source>> sources()
The sources used in the search.
-
_queries
final JsonField<List<String>> _queries()
Returns the raw JSON value of queries.
Unlike queries, this method doesn't throw if the JSON field has an unexpected type.
-
_query
@Deprecated(message = "deprecated") final JsonField<String> _query()
Returns the raw JSON value of query.
Unlike query, this method doesn't throw if the JSON field has an unexpected type.
-
_sources
final JsonField<List<ResponseFunctionWebSearch.Action.Search.Source>> _sources()
Returns the raw JSON value of sources.
Unlike sources, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFunctionWebSearch.Action.Search.Builder toBuilder()
-
validate
final ResponseFunctionWebSearch.Action.Search 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 ResponseFunctionWebSearch.Action.Search.Builder builder()
Returns a mutable builder for constructing an instance of Search.
-
-
-
-