Class ResponseCustomToolCallOutputItem.Builder
-
- All Implemented Interfaces:
public final class ResponseCustomToolCallOutputItem.BuilderA builder for ResponseCustomToolCallOutputItem.
-
-
Method Summary
-
-
Method Detail
-
callId
final ResponseCustomToolCallOutputItem.Builder callId(String callId)
The call ID, used to map this custom tool call output to a custom tool call.
-
callId
final ResponseCustomToolCallOutputItem.Builder callId(JsonField<String> callId)
Sets Builder.callId to an arbitrary JSON value.
You should usually call Builder.callId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
output
final ResponseCustomToolCallOutputItem.Builder output(ResponseCustomToolCallOutput.Output output)
The output from the custom tool call generated by your code. Can be a string or an list of output content.
-
output
final ResponseCustomToolCallOutputItem.Builder output(JsonField<ResponseCustomToolCallOutput.Output> output)
Sets Builder.output to an arbitrary JSON value.
You should usually call Builder.output with a well-typed ResponseCustomToolCallOutput.Output value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
output
final ResponseCustomToolCallOutputItem.Builder output(String string)
Alias for calling output with
ResponseCustomToolCallOutput.Output.ofString(string).
-
outputOfContentList
final ResponseCustomToolCallOutputItem.Builder outputOfContentList(List<ResponseCustomToolCallOutput.Output.FunctionAndCustomToolCallOutput> contentList)
Alias for calling output with
ResponseCustomToolCallOutput.Output.ofContentList(contentList).
-
type
final ResponseCustomToolCallOutputItem.Builder type(JsonValue type)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("custom_tool_call_output")This method is primarily for setting the field to an undocumented or not yet supported value.
-
id
final ResponseCustomToolCallOutputItem.Builder id(String id)
The unique ID of the custom tool call output in the OpenAI platform.
-
id
final ResponseCustomToolCallOutputItem.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final ResponseCustomToolCallOutputItem.Builder status(ResponseCustomToolCallOutputItem.Status status)
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
status
final ResponseCustomToolCallOutputItem.Builder status(JsonField<ResponseCustomToolCallOutputItem.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
createdBy
final ResponseCustomToolCallOutputItem.Builder createdBy(String createdBy)
The identifier of the actor that created the item.
-
createdBy
final ResponseCustomToolCallOutputItem.Builder createdBy(JsonField<String> createdBy)
Sets Builder.createdBy to an arbitrary JSON value.
You should usually call Builder.createdBy with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseCustomToolCallOutputItem.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseCustomToolCallOutputItem.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseCustomToolCallOutputItem.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseCustomToolCallOutputItem.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseCustomToolCallOutputItem.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseCustomToolCallOutputItem build()
Returns an immutable instance of ResponseCustomToolCallOutputItem.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.callId() .output() .status()
-
-
-
-