All Implemented Interfaces:


public final class ResponseOutputText.Annotation.ContainerFileCitation

A citation for a container file used to generate a model response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ResponseOutputText.Annotation.ContainerFileCitation.Builder`	A builder for ContainerFileCitation.

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 String`	`containerId()`	The ID of the container file.
`final Long`	`endIndex()`	The index of the last character of the container file citation in the message.
`final String`	`fileId()`	The ID of the file.
`final String`	`filename()`	The filename of the container file cited.
`final Long`	`startIndex()`	The index of the first character of the container file citation in the message.
`final JsonValue`	`_type()`	The type of the container file citation.
`final JsonField<String>`	`_containerId()`	Returns the raw JSON value of containerId.
`final JsonField<Long>`	`_endIndex()`	Returns the raw JSON value of endIndex.
`final JsonField<String>`	`_fileId()`	Returns the raw JSON value of fileId.
`final JsonField<String>`	`_filename()`	Returns the raw JSON value of filename.
`final JsonField<Long>`	`_startIndex()`	Returns the raw JSON value of startIndex.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ResponseOutputText.Annotation.ContainerFileCitation.Builder`	`toBuilder()`
`final ResponseOutputText.Annotation.ContainerFileCitation`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseOutputText.Annotation.ContainerFileCitation.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ContainerFileCitation.

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

- Constructor Detail
- Method Detail
  - containerId
```
 final String containerId()
```
    The ID of the container file.
  - endIndex
```
 final Long endIndex()
```
    The index of the last character of the container file citation in the message.
  - fileId
```
 final String fileId()
```
    The ID of the file.
  - filename
```
 final String filename()
```
    The filename of the container file cited.
  - startIndex
```
 final Long startIndex()
```
    The index of the first character of the container file citation in the message.
  - _type
```
 final JsonValue _type()
```
    The type of the container file citation. Always container_file_citation.
    Expected to always return the following:
    JsonValue.from("container_file_citation")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - _containerId
```
 final JsonField<String> _containerId()
```
    Returns the raw JSON value of containerId.
    Unlike containerId, this method doesn't throw if the JSON field has an unexpected type.
  - _endIndex
```
 final JsonField<Long> _endIndex()
```
    Returns the raw JSON value of endIndex.
    Unlike endIndex, this method doesn't throw if the JSON field has an unexpected type.
  - _fileId
```
 final JsonField<String> _fileId()
```
    Returns the raw JSON value of fileId.
    Unlike fileId, this method doesn't throw if the JSON field has an unexpected type.
  - _filename
```
 final JsonField<String> _filename()
```
    Returns the raw JSON value of filename.
    Unlike filename, this method doesn't throw if the JSON field has an unexpected type.
  - _startIndex
```
 final JsonField<Long> _startIndex()
```
    Returns the raw JSON value of startIndex.
    Unlike startIndex, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final ResponseOutputText.Annotation.ContainerFileCitation.Builder toBuilder()
```
  - validate
```
 final ResponseOutputText.Annotation.ContainerFileCitation validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ResponseOutputText.Annotation.ContainerFileCitation.Builder builder()
```
    Returns a mutable builder for constructing an instance of ContainerFileCitation.
    The following fields are required:
    .containerId() .endIndex() .fileId() .filename() .startIndex()

Class ResponseOutputText.Annotation.ContainerFileCitation

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

containerId

endIndex

fileId

filename

startIndex

_type

_containerId

_endIndex

_fileId

_filename

_startIndex

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder