Interface CitationsDelta.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CitationsDelta.Builder,CitationsDelta>, SdkBuilder<CitationsDelta.Builder,CitationsDelta>, SdkPojo
Enclosing class:
CitationsDelta
@Mutable @NotThreadSafe public static interface CitationsDelta.Builder extends SdkPojo, CopyableBuilder<CitationsDelta.Builder,CitationsDelta>

  • Method Details

    • title

      CitationsDelta.Builder title(String title)

      The title or identifier of the source document being cited.

      Parameters:
      title - The title or identifier of the source document being cited.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      CitationsDelta.Builder source(String source)

      The source from the original search result that provided the cited content.

      Parameters:
      source - The source from the original search result that provided the cited content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceContent

      CitationsDelta.Builder sourceContent(Collection<CitationSourceContentDelta> sourceContent)

      The specific content from the source document that was referenced or cited in the generated response.

      Parameters:
      sourceContent - The specific content from the source document that was referenced or cited in the generated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceContent

      CitationsDelta.Builder sourceContent(CitationSourceContentDelta... sourceContent)

      The specific content from the source document that was referenced or cited in the generated response.

      Parameters:
      sourceContent - The specific content from the source document that was referenced or cited in the generated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceContent

      CitationsDelta.Builder sourceContent(Consumer<CitationSourceContentDelta.Builder>... sourceContent)

      The specific content from the source document that was referenced or cited in the generated response.

      This is a convenience method that creates an instance of the CitationSourceContentDelta.Builder avoiding the need to create one manually via CitationSourceContentDelta.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceContent(List<CitationSourceContentDelta>).

      Parameters:
      sourceContent - a consumer that will call methods on CitationSourceContentDelta.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • location

      CitationsDelta.Builder location(CitationLocation location)

      Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

      Parameters:
      location - Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default CitationsDelta.Builder location(Consumer<CitationLocation.Builder> location)

      Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

      This is a convenience method that creates an instance of the CitationLocation.Builder avoiding the need to create one manually via CitationLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(CitationLocation).

      Parameters:
      location - a consumer that will call methods on CitationLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: