Constructor Detail

Method Detail

• id

   final RealtimeResponse.Builder id(String id)

  The unique ID of the response, will look like resp_1234.

• id

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

• audio

   final RealtimeResponse.Builder audio(RealtimeResponse.Audio audio)

  Configuration for audio output.

• audio

   final RealtimeResponse.Builder audio(JsonField<RealtimeResponse.Audio> audio)

  Sets Builder.audio to an arbitrary JSON value.

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

• conversationId

   final RealtimeResponse.Builder conversationId(String conversationId)

  Which conversation the response is added to, determined by the conversation field in the response.create event. If auto, the response will be added to the default conversation and the value of conversation_id will be an id like conv_1234. If none, the response will not be added to any conversation and the value of conversation_id will be null. If responses are being triggered automatically by VAD the response will be added to the default conversation

• conversationId

   final RealtimeResponse.Builder conversationId(JsonField<String> conversationId)

  Sets Builder.conversationId to an arbitrary JSON value.

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

• maxOutputTokens

   final RealtimeResponse.Builder maxOutputTokens(RealtimeResponse.MaxOutputTokens maxOutputTokens)

  Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.

• maxOutputTokens

   final RealtimeResponse.Builder maxOutputTokens(JsonField<RealtimeResponse.MaxOutputTokens> maxOutputTokens)

  Sets Builder.maxOutputTokens to an arbitrary JSON value.

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

• maxOutputTokens

   final RealtimeResponse.Builder maxOutputTokens(Long integer)

  Alias for calling maxOutputTokens with MaxOutputTokens.ofInteger(integer).

• maxOutputTokensInf

   final RealtimeResponse.Builder maxOutputTokensInf()

  Alias for calling maxOutputTokens with MaxOutputTokens.ofInf().

• metadata

   final RealtimeResponse.Builder metadata(RealtimeResponse.Metadata metadata)

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• metadata

   final RealtimeResponse.Builder metadata(Optional<RealtimeResponse.Metadata> metadata)

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

• metadata

   final RealtimeResponse.Builder metadata(JsonField<RealtimeResponse.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

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

• object_

   final RealtimeResponse.Builder object_(RealtimeResponse.Object object_)

  The object type, must be realtime.response.

• object_

   final RealtimeResponse.Builder object_(JsonField<RealtimeResponse.Object> object_)

  Sets Builder.object_ to an arbitrary JSON value.

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

• output

   final RealtimeResponse.Builder output(List<ConversationItem> output)

  The list of output items generated by the response.

• output

   final RealtimeResponse.Builder output(JsonField<List<ConversationItem>> output)

  Sets Builder.output to an arbitrary JSON value.

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

• addOutput

   final RealtimeResponse.Builder addOutput(ConversationItem output)

  Adds a single ConversationItem to Builder.output.

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)

  Alias for calling addOutput with ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)

  Alias for calling addOutput with ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)

  Alias for calling addOutput with ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeConversationItemFunctionCall functionCall)

  Alias for calling addOutput with ConversationItem.ofFunctionCall(functionCall).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeConversationItemFunctionCallOutput functionCallOutput)

  Alias for calling addOutput with ConversationItem.ofFunctionCallOutput(functionCallOutput).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeMcpApprovalResponse mcpApprovalResponse)

  Alias for calling addOutput with ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeMcpListTools mcpListTools)

  Alias for calling addOutput with ConversationItem.ofMcpListTools(mcpListTools).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeMcpToolCall mcpCall)

  Alias for calling addOutput with ConversationItem.ofMcpCall(mcpCall).

• addOutput

   final RealtimeResponse.Builder addOutput(RealtimeMcpApprovalRequest mcpApprovalRequest)

  Alias for calling addOutput with ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest).

• addRealtimeConversationItemSystemMessageOutput

   final RealtimeResponse.Builder addRealtimeConversationItemSystemMessageOutput(List<RealtimeConversationItemSystemMessage.Content> content)

  Alias for calling addOutput with the following:

  RealtimeConversationItemSystemMessage.builder()
      .content(content)
      .build()

• addRealtimeConversationItemUserMessageOutput

   final RealtimeResponse.Builder addRealtimeConversationItemUserMessageOutput(List<RealtimeConversationItemUserMessage.Content> content)

  Alias for calling addOutput with the following:

  RealtimeConversationItemUserMessage.builder()
      .content(content)
      .build()

• addRealtimeConversationItemAssistantMessageOutput

   final RealtimeResponse.Builder addRealtimeConversationItemAssistantMessageOutput(List<RealtimeConversationItemAssistantMessage.Content> content)

  Alias for calling addOutput with the following:

  RealtimeConversationItemAssistantMessage.builder()
      .content(content)
      .build()

• outputModalities

   final RealtimeResponse.Builder outputModalities(List<RealtimeResponse.OutputModality> outputModalities)

  The set of modalities the model used to respond, currently the only possible values are [\"audio\"], [\"text\"]. Audio output always include a text transcript. Setting the output to mode text will disable audio output from the model.

• outputModalities

   final RealtimeResponse.Builder outputModalities(JsonField<List<RealtimeResponse.OutputModality>> outputModalities)

  Sets Builder.outputModalities to an arbitrary JSON value.

  You should usually call Builder.outputModalities with a well-typed List<OutputModality> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addOutputModality

   final RealtimeResponse.Builder addOutputModality(RealtimeResponse.OutputModality outputModality)

  Adds a single OutputModality to outputModalities.

• status

   final RealtimeResponse.Builder status(RealtimeResponse.Status status)

  The final status of the response (completed, cancelled, failed, or incomplete, in_progress).

• status

   final RealtimeResponse.Builder status(JsonField<RealtimeResponse.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.

• statusDetails

   final RealtimeResponse.Builder statusDetails(RealtimeResponseStatus statusDetails)

  Additional details about the status.

• statusDetails

   final RealtimeResponse.Builder statusDetails(JsonField<RealtimeResponseStatus> statusDetails)

  Sets Builder.statusDetails to an arbitrary JSON value.

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

• usage

   final RealtimeResponse.Builder usage(RealtimeResponseUsage usage)

  Usage statistics for the Response, this will correspond to billing. A Realtime API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns.

• usage

   final RealtimeResponse.Builder usage(JsonField<RealtimeResponseUsage> usage)

  Sets Builder.usage to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final RealtimeResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final RealtimeResponse build()

  Returns an immutable instance of RealtimeResponse.

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