Constructor Detail

Method Detail

• callId

   final BetaResponseCustomToolCallOutputItem.Builder callId(String callId)

  The call ID, used to map this custom tool call output to a custom tool call.

• callId

   final BetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputItem.Builder output(BetaResponseCustomToolCallOutput.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 BetaResponseCustomToolCallOutputItem.Builder output(JsonField<BetaResponseCustomToolCallOutput.Output> output)

  Sets Builder.output to an arbitrary JSON value.

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

• output

   final BetaResponseCustomToolCallOutputItem.Builder output(String string)

  Alias for calling output with BetaResponseCustomToolCallOutput.Output.ofString(string).

• outputOfContentList

   final BetaResponseCustomToolCallOutputItem.Builder outputOfContentList(List<BetaResponseCustomToolCallOutput.Output.BetaFunctionAndCustomToolCallOutput> contentList)

  Alias for calling output with BetaResponseCustomToolCallOutput.Output.ofContentList(contentList).

• type

   final BetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputItem.Builder id(String id)

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

• id

   final BetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputItem.Builder agent(BetaResponseCustomToolCallOutput.Agent agent)

  The agent that produced this item.

• agent

   final BetaResponseCustomToolCallOutputItem.Builder agent(Optional<BetaResponseCustomToolCallOutput.Agent> agent)

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

• agent

   final BetaResponseCustomToolCallOutputItem.Builder agent(JsonField<BetaResponseCustomToolCallOutput.Agent> agent)

  Sets Builder.agent to an arbitrary JSON value.

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

• caller

   final BetaResponseCustomToolCallOutputItem.Builder caller(BetaResponseCustomToolCallOutput.Caller caller)

  The execution context that produced this tool call.

• caller

   final BetaResponseCustomToolCallOutputItem.Builder caller(Optional<BetaResponseCustomToolCallOutput.Caller> caller)

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

• caller

   final BetaResponseCustomToolCallOutputItem.Builder caller(JsonField<BetaResponseCustomToolCallOutput.Caller> caller)

  Sets Builder.caller to an arbitrary JSON value.

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

• caller

   final BetaResponseCustomToolCallOutputItem.Builder caller(BetaResponseCustomToolCallOutput.Caller.Program program)

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

• callerDirect

   final BetaResponseCustomToolCallOutputItem.Builder callerDirect()

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

• programCaller

   final BetaResponseCustomToolCallOutputItem.Builder programCaller(String callerId)

  Alias for calling caller with the following:

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

• status

   final BetaResponseCustomToolCallOutputItem.Builder status(BetaResponseCustomToolCallOutputItem.Status status)

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

• status

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

  The identifier of the actor that created the item.

• createdBy

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaResponseCustomToolCallOutputItem.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final BetaResponseCustomToolCallOutputItem build()

  Returns an immutable instance of BetaResponseCustomToolCallOutputItem.

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

  The following fields are required:

  .callId()
  .output()
  .status()