Class ChatCompletionCreateParams.WebSearchOptions.UserLocation
-
- All Implemented Interfaces:
public final class ChatCompletionCreateParams.WebSearchOptions.UserLocationApproximate location parameters for the search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionCreateParams.WebSearchOptions.UserLocation.BuilderA builder for UserLocation.
public final classChatCompletionCreateParams.WebSearchOptions.UserLocation.ApproximateApproximate location parameters for the search.
-
Method Summary
Modifier and Type Method Description final ChatCompletionCreateParams.WebSearchOptions.UserLocation.Approximateapproximate()Approximate location parameters for the search. final JsonValue_type()The type of location approximation. final JsonField<ChatCompletionCreateParams.WebSearchOptions.UserLocation.Approximate>_approximate()Returns the raw JSON value of approximate. final Map<String, JsonValue>_additionalProperties()final ChatCompletionCreateParams.WebSearchOptions.UserLocation.BuildertoBuilder()final ChatCompletionCreateParams.WebSearchOptions.UserLocationvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionCreateParams.WebSearchOptions.UserLocation.Builderbuilder()Returns a mutable builder for constructing an instance of UserLocation. -
-
Method Detail
-
approximate
final ChatCompletionCreateParams.WebSearchOptions.UserLocation.Approximate approximate()
Approximate location parameters for the search.
-
_type
final JsonValue _type()
The type of location approximation. Always
approximate.Expected to always return the following:
JsonValue.from("approximate")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_approximate
final JsonField<ChatCompletionCreateParams.WebSearchOptions.UserLocation.Approximate> _approximate()
Returns the raw JSON value of approximate.
Unlike approximate, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionCreateParams.WebSearchOptions.UserLocation.Builder toBuilder()
-
validate
final ChatCompletionCreateParams.WebSearchOptions.UserLocation 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 ChatCompletionCreateParams.WebSearchOptions.UserLocation.Builder builder()
Returns a mutable builder for constructing an instance of UserLocation.
The following fields are required:
.approximate()
-
-
-
-