google-genai/com.google.genai.interactions.models.interactions/FileCitation

FileCitation

public final class FileCitation

A file citation annotation.

Types

Builder

public final class Builder

A builder for FileCitation.

CustomMetadata

public final class CustomMetadata

User provided metadata about the retrieved context.

Functions

_additionalProperties

public final Map<String, JsonValue> _additionalProperties()

_customMetadata

public final JsonField<FileCitation.CustomMetadata> _customMetadata()

Returns the raw JSON value of customMetadata.

_documentUri

public final JsonField<String> _documentUri()

Returns the raw JSON value of documentUri.

_endIndex

public final JsonField<Integer> _endIndex()

Returns the raw JSON value of endIndex.

_fileName

public final JsonField<String> _fileName()

Returns the raw JSON value of fileName.

_mediaId

public final JsonField<String> _mediaId()

Returns the raw JSON value of mediaId.

_pageNumber

public final JsonField<Integer> _pageNumber()

Returns the raw JSON value of pageNumber.

_source

public final JsonField<String> _source()

Returns the raw JSON value of source.

_startIndex

public final JsonField<Integer> _startIndex()

Returns the raw JSON value of startIndex.

_type

public final JsonValue _type()

Expected to always return the following:

builder

public final static FileCitation.Builder builder()

Returns a mutable builder for constructing an instance of FileCitation.

customMetadata

public final Optional<FileCitation.CustomMetadata> customMetadata()

User provided metadata about the retrieved context.

documentUri

public final Optional<String> documentUri()

The URI of the file.

endIndex

public final Optional<Integer> endIndex()

End of the attributed segment, exclusive.

equals

public Boolean equals(Object other)

fileName

public final Optional<String> fileName()

The name of the file.

hashCode

public Integer hashCode()

isValid

public final Boolean isValid()

mediaId

public final Optional<String> mediaId()

Media ID in-case of image citations, if applicable.

pageNumber

public final Optional<Integer> pageNumber()

Page number of the cited document, if applicable.

source

public final Optional<String> source()

Source attributed for a portion of the text.

startIndex

public final Optional<Integer> startIndex()

Start of segment of the response that is attributed to this source.

toBuilder

public final FileCitation.Builder toBuilder()

toString

public String toString()

validate

public final FileCitation validate()