Constructor Detail

Method Detail

• callId

   final BetaResponseCustomToolCallItem.Builder callId(String callId)

  An identifier used to map this custom tool call to a tool call output.

• callId

   final BetaResponseCustomToolCallItem.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.

• input

   final BetaResponseCustomToolCallItem.Builder input(String input)

  The input for the custom tool call generated by the model.

• input

   final BetaResponseCustomToolCallItem.Builder input(JsonField<String> input)

  Sets Builder.input to an arbitrary JSON value.

  You should usually call Builder.input 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 BetaResponseCustomToolCallItem.Builder name(String name)

  The name of the custom tool being called.

• name

   final BetaResponseCustomToolCallItem.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.

• type

   final BetaResponseCustomToolCallItem.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")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• id

   final BetaResponseCustomToolCallItem.Builder id(String id)

  The unique ID of the custom tool call in the OpenAI platform.

• id

   final BetaResponseCustomToolCallItem.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.

• agent

   final BetaResponseCustomToolCallItem.Builder agent(BetaResponseCustomToolCall.Agent agent)

  The agent that produced this item.

• agent

   final BetaResponseCustomToolCallItem.Builder agent(Optional<BetaResponseCustomToolCall.Agent> agent)

  Alias for calling Builder.agent with agent.orElse(null).

• agent

   final BetaResponseCustomToolCallItem.Builder agent(JsonField<BetaResponseCustomToolCall.Agent> agent)

  Sets Builder.agent to an arbitrary JSON value.

  You should usually call Builder.agent with a well-typed BetaResponseCustomToolCall.Agent value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• caller

   final BetaResponseCustomToolCallItem.Builder caller(BetaResponseCustomToolCall.Caller caller)

  The execution context that produced this tool call.

• caller

   final BetaResponseCustomToolCallItem.Builder caller(Optional<BetaResponseCustomToolCall.Caller> caller)

  Alias for calling Builder.caller with caller.orElse(null).

• caller

   final BetaResponseCustomToolCallItem.Builder caller(JsonField<BetaResponseCustomToolCall.Caller> caller)

  Sets Builder.caller to an arbitrary JSON value.

  You should usually call Builder.caller with a well-typed BetaResponseCustomToolCall.Caller value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• caller

   final BetaResponseCustomToolCallItem.Builder caller(BetaResponseCustomToolCall.Caller.Program program)

  Alias for calling caller with BetaResponseCustomToolCall.Caller.ofProgram(program).

• callerDirect

   final BetaResponseCustomToolCallItem.Builder callerDirect()

  Alias for calling caller with BetaResponseCustomToolCall.Caller.ofDirect().

• programCaller

   final BetaResponseCustomToolCallItem.Builder programCaller(String callerId)

  Alias for calling caller with the following:

  BetaResponseCustomToolCall.Caller.Program.builder()
      .callerId(callerId)
      .build()

• namespace

   final BetaResponseCustomToolCallItem.Builder namespace(String namespace)

  The namespace of the custom tool being called.

• namespace

   final BetaResponseCustomToolCallItem.Builder namespace(JsonField<String> namespace)

  Sets Builder.namespace to an arbitrary JSON value.

  You should usually call Builder.namespace 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 BetaResponseCustomToolCallItem.Builder status(BetaResponseCustomToolCallItem.Status status)

  The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

• status

   final BetaResponseCustomToolCallItem.Builder status(JsonField<BetaResponseCustomToolCallItem.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 BetaResponseCustomToolCallItem.Builder createdBy(String createdBy)

  The identifier of the actor that created the item.

• createdBy

   final BetaResponseCustomToolCallItem.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 BetaResponseCustomToolCallItem.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaResponseCustomToolCallItem.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaResponseCustomToolCallItem.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaResponseCustomToolCallItem.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaResponseCustomToolCallItem.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaResponseCustomToolCallItem build()

  Returns an immutable instance of BetaResponseCustomToolCallItem.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .callId()
  .input()
  .name()
  .status()