Class ChatCompletionCustomTool.Custom
-
- All Implemented Interfaces:
public final class ChatCompletionCustomTool.CustomProperties of the custom tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionCustomTool.Custom.BuilderA builder for Custom.
public final classChatCompletionCustomTool.Custom.FormatThe input format for the custom tool. Default is unconstrained text.
-
Method Summary
Modifier and Type Method Description final Stringname()The name of the custom tool, used to identify it in tool calls. final Optional<String>description()Optional description of the custom tool, used to provide more context. final Optional<ChatCompletionCustomTool.Custom.Format>format()The input format for the custom tool. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<ChatCompletionCustomTool.Custom.Format>_format()Returns the raw JSON value of format. final Map<String, JsonValue>_additionalProperties()final ChatCompletionCustomTool.Custom.BuildertoBuilder()final ChatCompletionCustomTool.Customvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionCustomTool.Custom.Builderbuilder()Returns a mutable builder for constructing an instance of Custom. -
-
Method Detail
-
description
final Optional<String> description()
Optional description of the custom tool, used to provide more context.
-
format
final Optional<ChatCompletionCustomTool.Custom.Format> format()
The input format for the custom tool. Default is unconstrained text.
-
_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.
-
_format
final JsonField<ChatCompletionCustomTool.Custom.Format> _format()
Returns the raw JSON value of format.
Unlike format, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionCustomTool.Custom.Builder toBuilder()
-
validate
final ChatCompletionCustomTool.Custom validate()
-
builder
final static ChatCompletionCustomTool.Custom.Builder builder()
Returns a mutable builder for constructing an instance of Custom.
The following fields are required:
.name()
-
-
-
-