Class ChatCompletionCreateParams.Function
-
- All Implemented Interfaces:
@Deprecated(message = "deprecated") public final class ChatCompletionCreateParams.Function
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionCreateParams.Function.BuilderA builder for Function.
-
Method Summary
Modifier and Type Method Description final Stringname()The name of the function to be called. final Optional<String>description()A description of what the function does, used by the model to choose when and how to call the function. final Optional<FunctionParameters>parameters()The parameters the functions accepts, described as a JSON Schema object. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<FunctionParameters>_parameters()Returns the raw JSON value of parameters. final Map<String, JsonValue>_additionalProperties()final ChatCompletionCreateParams.Function.BuildertoBuilder()final ChatCompletionCreateParams.Functionvalidate()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.Function.Builderbuilder()Returns a mutable builder for constructing an instance of Function. -
-
Method Detail
-
name
final String name()
The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
-
description
final Optional<String> description()
A description of what the function does, used by the model to choose when and how to call the function.
-
parameters
final Optional<FunctionParameters> parameters()
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
Omitting
parametersdefines a function with an empty parameter list.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_parameters
final JsonField<FunctionParameters> _parameters()
Returns the raw JSON value of parameters.
Unlike parameters, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionCreateParams.Function.Builder toBuilder()
-
validate
final ChatCompletionCreateParams.Function 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.Function.Builder builder()
Returns a mutable builder for constructing an instance of Function.
The following fields are required:
.name()
-
-
-
-