All Implemented Interfaces:
```
public final class FileCitationDeltaAnnotation

                    
```
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileCitationDeltaAnnotation.Builder`
`public final class`	`FileCitationDeltaAnnotation.Type`	Always `file_citation`.
`public final class`	`FileCitationDeltaAnnotation.FileCitation`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`index()`	The index of the annotation in the text content part.
`final FileCitationDeltaAnnotation.Type`	`type()`	Always `file_citation`.
`final Optional<Long>`	`endIndex()`
`final Optional<FileCitationDeltaAnnotation.FileCitation>`	`fileCitation()`
`final Optional<Long>`	`startIndex()`
`final Optional<String>`	`text()`	The text in the message content that needs to be replaced.
`final JsonField<Long>`	`_index()`	The index of the annotation in the text content part.
`final JsonField<FileCitationDeltaAnnotation.Type>`	`_type()`	Always `file_citation`.
`final JsonField<Long>`	`_endIndex()`
`final JsonField<FileCitationDeltaAnnotation.FileCitation>`	`_fileCitation()`
`final JsonField<Long>`	`_startIndex()`
`final JsonField<String>`	`_text()`	The text in the message content that needs to be replaced.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final FileCitationDeltaAnnotation`	`validate()`
`final FileCitationDeltaAnnotation.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileCitationDeltaAnnotation.Builder`	`builder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

index
```
 final Long index()
```
The index of the annotation in the text content part.

type

 final FileCitationDeltaAnnotation.Type type()

Always file_citation.

endIndex
```
 final Optional<Long> endIndex()
```

fileCitation

 final Optional<FileCitationDeltaAnnotation.FileCitation> fileCitation()

startIndex
```
 final Optional<Long> startIndex()
```

text
```
 final Optional<String> text()
```
The text in the message content that needs to be replaced.

_index
```
 final JsonField<Long> _index()
```
The index of the annotation in the text content part.

_type

 final JsonField<FileCitationDeltaAnnotation.Type> _type()

Always file_citation.

_endIndex
```
 final JsonField<Long> _endIndex()
```

_fileCitation

 final JsonField<FileCitationDeltaAnnotation.FileCitation> _fileCitation()

_startIndex
```
 final JsonField<Long> _startIndex()
```

_text
```
 final JsonField<String> _text()
```
The text in the message content that needs to be replaced.

_additionalProperties

 final Map<String, JsonValue> _additionalProperties()

validate

 final FileCitationDeltaAnnotation validate()

toBuilder

 final FileCitationDeltaAnnotation.Builder toBuilder()

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

builder

 final static FileCitationDeltaAnnotation.Builder builder()

Class FileCitationDeltaAnnotation

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

index

type

endIndex

fileCitation

startIndex

text

_index

_type

_endIndex

_fileCitation

_startIndex

_text

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder