Constructor Detail

Method Detail

• annotation

   final BetaResponseOutputTextAnnotationAddedEvent.Builder annotation(JsonValue annotation)

  The annotation object being added. (See annotation schema for details.)

• annotationIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder annotationIndex(Long annotationIndex)

  The index of the annotation within the content part.

• annotationIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder annotationIndex(JsonField<Long> annotationIndex)

  Sets Builder.annotationIndex to an arbitrary JSON value.

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

• contentIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder contentIndex(Long contentIndex)

  The index of the content part within the output item.

• contentIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder contentIndex(JsonField<Long> contentIndex)

  Sets Builder.contentIndex to an arbitrary JSON value.

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

• itemId

   final BetaResponseOutputTextAnnotationAddedEvent.Builder itemId(String itemId)

  The unique identifier of the item to which the annotation is being added.

• itemId

   final BetaResponseOutputTextAnnotationAddedEvent.Builder itemId(JsonField<String> itemId)

  Sets Builder.itemId to an arbitrary JSON value.

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

• outputIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder outputIndex(Long outputIndex)

  The index of the output item in the response's output array.

• outputIndex

   final BetaResponseOutputTextAnnotationAddedEvent.Builder outputIndex(JsonField<Long> outputIndex)

  Sets Builder.outputIndex to an arbitrary JSON value.

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

• sequenceNumber

   final BetaResponseOutputTextAnnotationAddedEvent.Builder sequenceNumber(Long sequenceNumber)

  The sequence number of this event.

• sequenceNumber

   final BetaResponseOutputTextAnnotationAddedEvent.Builder sequenceNumber(JsonField<Long> sequenceNumber)

  Sets Builder.sequenceNumber to an arbitrary JSON value.

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

• type

   final BetaResponseOutputTextAnnotationAddedEvent.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("response.output_text.annotation.added")

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

• agent

   final BetaResponseOutputTextAnnotationAddedEvent.Builder agent(BetaResponseOutputTextAnnotationAddedEvent.Agent agent)

  The agent that owns this multi-agent streaming event.

• agent

   final BetaResponseOutputTextAnnotationAddedEvent.Builder agent(Optional<BetaResponseOutputTextAnnotationAddedEvent.Agent> agent)

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

• agent

   final BetaResponseOutputTextAnnotationAddedEvent.Builder agent(JsonField<BetaResponseOutputTextAnnotationAddedEvent.Agent> agent)

  Sets Builder.agent to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaResponseOutputTextAnnotationAddedEvent.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final BetaResponseOutputTextAnnotationAddedEvent build()

  Returns an immutable instance of BetaResponseOutputTextAnnotationAddedEvent.

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

  The following fields are required:

  .annotation()
  .annotationIndex()
  .contentIndex()
  .itemId()
  .outputIndex()
  .sequenceNumber()