Package com.openai.models.realtime
Class RealtimeFunctionTool
-
- All Implemented Interfaces:
public final class RealtimeFunctionTool
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeFunctionTool.BuilderA builder for RealtimeFunctionTool.
public final classRealtimeFunctionTool.TypeThe type of the tool, i.e.
function.
-
Method Summary
Modifier and Type Method Description final Optional<String>description()The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything). final Optional<String>name()The name of the function. final JsonValue_parameters()Parameters of the function in JSON Schema. final Optional<RealtimeFunctionTool.Type>type()The type of the tool, i.e. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<RealtimeFunctionTool.Type>_type()Returns the raw JSON value of type. final Map<String, JsonValue>_additionalProperties()final RealtimeFunctionTool.BuildertoBuilder()final RealtimeFunctionToolvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeFunctionTool.Builderbuilder()Returns a mutable builder for constructing an instance of RealtimeFunctionTool. -
-
Method Detail
-
description
final Optional<String> description()
The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).
-
_parameters
final JsonValue _parameters()
Parameters of the function in JSON Schema.
-
type
final Optional<RealtimeFunctionTool.Type> type()
The type of the tool, i.e.
function.
-
_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.
-
_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.
-
_type
final JsonField<RealtimeFunctionTool.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeFunctionTool.Builder toBuilder()
-
validate
final RealtimeFunctionTool validate()
-
builder
final static RealtimeFunctionTool.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeFunctionTool.
-
-
-
-