Class ResponseOutputTextAnnotationAddedEvent.Builder
-
- All Implemented Interfaces:
public final class ResponseOutputTextAnnotationAddedEvent.Builder
A builder for ResponseOutputTextAnnotationAddedEvent.
-
-
Method Summary
-
-
Method Detail
-
annotation
final ResponseOutputTextAnnotationAddedEvent.Builder annotation(JsonValue annotation)
The annotation object being added. (See annotation schema for details.)
-
annotationIndex
final ResponseOutputTextAnnotationAddedEvent.Builder annotationIndex(Long annotationIndex)
The index of the annotation within the content part.
-
annotationIndex
final ResponseOutputTextAnnotationAddedEvent.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 ResponseOutputTextAnnotationAddedEvent.Builder contentIndex(Long contentIndex)
The index of the content part within the output item.
-
contentIndex
final ResponseOutputTextAnnotationAddedEvent.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 ResponseOutputTextAnnotationAddedEvent.Builder itemId(String itemId)
The unique identifier of the item to which the annotation is being added.
-
itemId
final ResponseOutputTextAnnotationAddedEvent.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 ResponseOutputTextAnnotationAddedEvent.Builder outputIndex(Long outputIndex)
The index of the output item in the response's output array.
-
outputIndex
final ResponseOutputTextAnnotationAddedEvent.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 ResponseOutputTextAnnotationAddedEvent.Builder sequenceNumber(Long sequenceNumber)
The sequence number of this event.
-
sequenceNumber
final ResponseOutputTextAnnotationAddedEvent.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 ResponseOutputTextAnnotationAddedEvent.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.
-
additionalProperties
final ResponseOutputTextAnnotationAddedEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseOutputTextAnnotationAddedEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseOutputTextAnnotationAddedEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseOutputTextAnnotationAddedEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseOutputTextAnnotationAddedEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseOutputTextAnnotationAddedEvent build()
Returns an immutable instance of ResponseOutputTextAnnotationAddedEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.annotation() .annotationIndex() .contentIndex() .itemId() .outputIndex() .sequenceNumber()
-
-
-
-