Class ResponseTextAnnotationDeltaEvent.Builder
-
- All Implemented Interfaces:
public final class ResponseTextAnnotationDeltaEvent.Builder
A builder for ResponseTextAnnotationDeltaEvent.
-
-
Method Summary
-
-
Method Detail
-
annotation
final ResponseTextAnnotationDeltaEvent.Builder annotation(ResponseTextAnnotationDeltaEvent.Annotation annotation)
A citation to a file.
-
annotation
final ResponseTextAnnotationDeltaEvent.Builder annotation(JsonField<ResponseTextAnnotationDeltaEvent.Annotation> annotation)
Sets Builder.annotation to an arbitrary JSON value.
You should usually call Builder.annotation with a well-typed Annotation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
annotation
final ResponseTextAnnotationDeltaEvent.Builder annotation(ResponseTextAnnotationDeltaEvent.Annotation.FileCitation fileCitation)
Alias for calling annotation with
Annotation.ofFileCitation(fileCitation)
.
-
annotation
final ResponseTextAnnotationDeltaEvent.Builder annotation(ResponseTextAnnotationDeltaEvent.Annotation.UrlCitation urlCitation)
Alias for calling annotation with
Annotation.ofUrlCitation(urlCitation)
.
-
annotation
final ResponseTextAnnotationDeltaEvent.Builder annotation(ResponseTextAnnotationDeltaEvent.Annotation.FilePath filePath)
Alias for calling annotation with
Annotation.ofFilePath(filePath)
.
-
annotationIndex
final ResponseTextAnnotationDeltaEvent.Builder annotationIndex(Long annotationIndex)
The index of the annotation that was added.
-
annotationIndex
final ResponseTextAnnotationDeltaEvent.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 ResponseTextAnnotationDeltaEvent.Builder contentIndex(Long contentIndex)
The index of the content part that the text annotation was added to.
-
contentIndex
final ResponseTextAnnotationDeltaEvent.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 ResponseTextAnnotationDeltaEvent.Builder itemId(String itemId)
The ID of the output item that the text annotation was added to.
-
itemId
final ResponseTextAnnotationDeltaEvent.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 ResponseTextAnnotationDeltaEvent.Builder outputIndex(Long outputIndex)
The index of the output item that the text annotation was added to.
-
outputIndex
final ResponseTextAnnotationDeltaEvent.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.
-
type
final ResponseTextAnnotationDeltaEvent.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 ResponseTextAnnotationDeltaEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseTextAnnotationDeltaEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseTextAnnotationDeltaEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseTextAnnotationDeltaEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseTextAnnotationDeltaEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseTextAnnotationDeltaEvent build()
Returns an immutable instance of ResponseTextAnnotationDeltaEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.annotation() .annotationIndex() .contentIndex() .itemId() .outputIndex()
-
-
-
-