Package com.openai.models.responses
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.
-
Method Summary
Modifier and Type Method Description final Stringquery()The search query. final JsonValue_type()The action type. final JsonField<String>_query()Returns the raw JSON value of query. final Map<String, JsonValue>_additionalProperties()final ResponseFunctionWebSearch.Action.Search.BuildertoBuilder()final ResponseFunctionWebSearch.Action.Searchvalidate()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
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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFunctionWebSearch.Action.Search.Builder toBuilder()
-
validate
final ResponseFunctionWebSearch.Action.Search validate()
-
builder
final static ResponseFunctionWebSearch.Action.Search.Builder builder()
Returns a mutable builder for constructing an instance of Search.
The following fields are required:
.query()
-
-
-
-