Package com.google.genai.gaos.models.interactions

Class FileCitation.Builder

java.lang.Object

com.google.genai.gaos.models.interactions.FileCitation.Builder

Enclosing class:

FileCitation

public static final class FileCitation.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
FileCitation	build()
FileCitation.Builder	customMetadata(Map<String,Object> customMetadata)	User provided metadata about the retrieved context.
FileCitation.Builder	documentUri(String documentUri)	The URI of the file.
FileCitation.Builder	endIndex(Integer endIndex)	End of the attributed segment, exclusive.
FileCitation.Builder	fileName(String fileName)	The name of the file.
FileCitation.Builder	mediaId(String mediaId)	Media ID in-case of image citations, if applicable.
FileCitation.Builder	pageNumber(Integer pageNumber)	Page number of the cited document, if applicable.
FileCitation.Builder	source(String source)	Source attributed for a portion of the text.
FileCitation.Builder	startIndex(Integer startIndex)	Start of segment of the response that is attributed to this source.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

customMetadata

public FileCitation.Builder customMetadata(@Nullable
 Map<String,Object> customMetadata)

User provided metadata about the retrieved context.

documentUri

public FileCitation.Builder documentUri(@Nullable
 String documentUri)

The URI of the file.

endIndex

public FileCitation.Builder endIndex(@Nullable
 Integer endIndex)

End of the attributed segment, exclusive.

fileName

public FileCitation.Builder fileName(@Nullable
 String fileName)

The name of the file.

mediaId

public FileCitation.Builder mediaId(@Nullable
 String mediaId)

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

pageNumber

public FileCitation.Builder pageNumber(@Nullable
 Integer pageNumber)

Page number of the cited document, if applicable.

source

public FileCitation.Builder source(@Nullable
 String source)

Source attributed for a portion of the text.

startIndex

public FileCitation.Builder startIndex(@Nullable
 Integer startIndex)

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

Index indicates the start of the segment, measured in bytes.

build

public FileCitation build()