Class Session.Tool.Builder
-
- All Implemented Interfaces:
public final class Session.Tool.Builder
A builder for Tool.
-
-
Method Summary
Modifier and Type Method Description final Session.Tool.Builder
description(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 Session.Tool.Builder
description(JsonField<String> description)
Sets Builder.description to an arbitrary JSON value. final Session.Tool.Builder
name(String name)
The name of the function. final Session.Tool.Builder
name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value. final Session.Tool.Builder
parameters(JsonValue parameters)
Parameters of the function in JSON Schema. final Session.Tool.Builder
type(Session.Tool.Type type)
The type of the tool, i.e. final Session.Tool.Builder
type(JsonField<Session.Tool.Type> type)
Sets Builder.type to an arbitrary JSON value. final Session.Tool.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final Session.Tool.Builder
putAdditionalProperty(String key, JsonValue value)
final Session.Tool.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final Session.Tool.Builder
removeAdditionalProperty(String key)
final Session.Tool.Builder
removeAllAdditionalProperties(Set<String> keys)
final Session.Tool
build()
Returns an immutable instance of Tool. -
-
Method Detail
-
description
final Session.Tool.Builder description(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).
-
description
final Session.Tool.Builder description(JsonField<String> description)
Sets Builder.description to an arbitrary JSON value.
You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
name
final Session.Tool.Builder name(String name)
The name of the function.
-
name
final Session.Tool.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
parameters
final Session.Tool.Builder parameters(JsonValue parameters)
Parameters of the function in JSON Schema.
-
type
final Session.Tool.Builder type(Session.Tool.Type type)
The type of the tool, i.e.
function
.
-
type
final Session.Tool.Builder type(JsonField<Session.Tool.Type> type)
Sets Builder.type to an arbitrary JSON value.
You should usually call Builder.type with a well-typed Type value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final Session.Tool.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final Session.Tool.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final Session.Tool.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final Session.Tool.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final Session.Tool.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final Session.Tool build()
Returns an immutable instance of Tool.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-