Constructor Detail

Method Detail

• callId

   final String callId()

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

• input

   final String input()

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

• name

   final String name()

  The name of the custom tool being called.

• _type

   final JsonValue _type()

  The type of the custom tool call. Always custom_tool_call.

  Expected to always return the following:

  JsonValue.from("custom_tool_call")

  However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).

• id

   final Optional<String> id()

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

• agent

   final Optional<BetaResponseCustomToolCall.Agent> agent()

  The agent that produced this item.

• caller

   final Optional<BetaResponseCustomToolCall.Caller> caller()

  The execution context that produced this tool call.

• namespace

   final Optional<String> namespace()

  The namespace of the custom tool being called.

• _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.

• _input

   final JsonField<String> _input()

  Returns the raw JSON value of input.

  Unlike input, 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.

• _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.

• _agent

   final JsonField<BetaResponseCustomToolCall.Agent> _agent()

  Returns the raw JSON value of agent.

  Unlike agent, this method doesn't throw if the JSON field has an unexpected type.

• _caller

   final JsonField<BetaResponseCustomToolCall.Caller> _caller()

  Returns the raw JSON value of caller.

  Unlike caller, this method doesn't throw if the JSON field has an unexpected type.

• _namespace

   final JsonField<String> _namespace()

  Returns the raw JSON value of namespace.

  Unlike namespace, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final BetaResponseCustomToolCall.Builder toBuilder()

• validate

   final BetaResponseCustomToolCall validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static BetaResponseCustomToolCall.Builder builder()

  Returns a mutable builder for constructing an instance of BetaResponseCustomToolCall.

  The following fields are required:

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