Class ChatKitThreadItemList.Data.ChatKitClientToolCall
-
- All Implemented Interfaces:
public final class ChatKitThreadItemList.Data.ChatKitClientToolCallRecord of a client side tool invocation initiated by the assistant.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatKitThreadItemList.Data.ChatKitClientToolCall.BuilderA builder for ChatKitClientToolCall.
public final classChatKitThreadItemList.Data.ChatKitClientToolCall.StatusExecution status for the tool call.
-
Method Summary
Modifier and Type Method Description final Stringid()Identifier of the thread item. final Stringarguments()JSON-encoded arguments that were sent to the tool. final StringcallId()Identifier for the client tool call. final LongcreatedAt()Unix timestamp (in seconds) for when the item was created. final Stringname()Tool name that was invoked. final JsonValue_object_()Type discriminator that is always chatkit.thread_item.final Optional<String>output()JSON-encoded output captured from the tool. final ChatKitThreadItemList.Data.ChatKitClientToolCall.Statusstatus()Execution status for the tool call. final StringthreadId()Identifier of the parent thread. final JsonValue_type()Type discriminator that is always chatkit.client_tool_call.final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>_arguments()Returns the raw JSON value of arguments. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<Long>_createdAt()Returns the raw JSON value of createdAt. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_output()Returns the raw JSON value of output. final JsonField<ChatKitThreadItemList.Data.ChatKitClientToolCall.Status>_status()Returns the raw JSON value of status. final JsonField<String>_threadId()Returns the raw JSON value of threadId. final Map<String, JsonValue>_additionalProperties()final ChatKitThreadItemList.Data.ChatKitClientToolCall.BuildertoBuilder()final ChatKitThreadItemList.Data.ChatKitClientToolCallvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatKitThreadItemList.Data.ChatKitClientToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of ChatKitClientToolCall. -
-
Method Detail
-
_object_
final JsonValue _object_()
Type discriminator that is always
chatkit.thread_item.Expected to always return the following:
JsonValue.from("chatkit.thread_item")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
output
final Optional<String> output()
JSON-encoded output captured from the tool. Defaults to null while execution is in progress.
-
status
final ChatKitThreadItemList.Data.ChatKitClientToolCall.Status status()
Execution status for the tool call.
-
_type
final JsonValue _type()
Type discriminator that is always
chatkit.client_tool_call.Expected to always return the following:
JsonValue.from("chatkit.client_tool_call")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_arguments
final JsonField<String> _arguments()
Returns the raw JSON value of arguments.
Unlike arguments, this method doesn't throw if the JSON field has an unexpected type.
-
_callId
final JsonField<String> _callId()
Returns the raw JSON value of callId.
Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, 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.
-
_output
final JsonField<String> _output()
Returns the raw JSON value of output.
Unlike output, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<ChatKitThreadItemList.Data.ChatKitClientToolCall.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_threadId
final JsonField<String> _threadId()
Returns the raw JSON value of threadId.
Unlike threadId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatKitThreadItemList.Data.ChatKitClientToolCall.Builder toBuilder()
-
validate
final ChatKitThreadItemList.Data.ChatKitClientToolCall validate()
-
builder
final static ChatKitThreadItemList.Data.ChatKitClientToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ChatKitClientToolCall.
The following fields are required:
.id() .arguments() .callId() .createdAt() .name() .output() .status() .threadId()
-
-
-
-