All Implemented Interfaces:
```
public final class FileCitationAnnotation

                    
```
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`	`FileCitationAnnotation.Builder`	A builder for FileCitationAnnotation.
`public final class`	`FileCitationAnnotation.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`	`endIndex()`
`final FileCitationAnnotation.FileCitation`	`fileCitation()`
`final Long`	`startIndex()`
`final String`	`text()`	The text in the message content that needs to be replaced.
`final JsonValue`	`_type()`	Always `file_citation`.
`final JsonField<Long>`	`_endIndex()`
`final JsonField<FileCitationAnnotation.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 FileCitationAnnotation`	`validate()`
`final FileCitationAnnotation.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileCitationAnnotation.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FileCitationAnnotation.

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

Constructor Detail

Method Detail

endIndex
```
 final Long endIndex()
```

fileCitation

 final FileCitationAnnotation.FileCitation fileCitation()

startIndex
```
 final Long startIndex()
```

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

_type
```
 final JsonValue _type()
```
Always file_citation.

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

_fileCitation

 final JsonField<FileCitationAnnotation.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 FileCitationAnnotation validate()

toBuilder

 final FileCitationAnnotation.Builder toBuilder()

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

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

builder
```
 final static FileCitationAnnotation.Builder builder()
```
Returns a mutable builder for constructing an instance of FileCitationAnnotation.
The following fields are required:
```
.endIndex()
.fileCitation()
.startIndex()
.text()
```

Class FileCitationAnnotation

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

endIndex

fileCitation

startIndex

text

_type

_endIndex

_fileCitation

_startIndex

_text

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder