Package com.google.cloud.discoveryengine.v1beta

Interface ChunkOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Chunk, Chunk.Builder
@Generated public interface ChunkOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The full resource name of the chunk.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The full resource name of the chunk.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.
      string name = 1;
      Returns:
      The bytes for name.

    • getId

      String getId()
       Unique chunk ID of the current chunk.
      string id = 2;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Unique chunk ID of the current chunk.
      string id = 2;
      Returns:
      The bytes for id.

    • getContent

      String getContent()
       Content is a string from a document (parsed content).
      string content = 3;
      Returns:
      The content.

    • getContentBytes

      com.google.protobuf.ByteString getContentBytes()
       Content is a string from a document (parsed content).
      string content = 3;
      Returns:
      The bytes for content.

    • hasRelevanceScore

      boolean hasRelevanceScore()
       Output only. Represents the relevance score based on similarity.
 Higher score indicates higher chunk relevance.
 The score is in range [-1.0, 1.0].
 Only populated on [SearchService.SearchResponse][].
      optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the relevanceScore field is set.

    • getRelevanceScore

      double getRelevanceScore()
       Output only. Represents the relevance score based on similarity.
 Higher score indicates higher chunk relevance.
 The score is in range [-1.0, 1.0].
 Only populated on [SearchService.SearchResponse][].
      optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The relevanceScore.

    • hasDocumentMetadata

      boolean hasDocumentMetadata()
       Metadata of the document from the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.DocumentMetadata document_metadata = 5;
      Returns:
      Whether the documentMetadata field is set.

    • getDocumentMetadata

      Chunk.DocumentMetadata getDocumentMetadata()
       Metadata of the document from the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.DocumentMetadata document_metadata = 5;
      Returns:
      The documentMetadata.

    • getDocumentMetadataOrBuilder

      Chunk.DocumentMetadataOrBuilder getDocumentMetadataOrBuilder()
       Metadata of the document from the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.DocumentMetadata document_metadata = 5;

    • hasDerivedStructData

      boolean hasDerivedStructData()
       Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
      .google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the derivedStructData field is set.

    • getDerivedStructData

      com.google.protobuf.Struct getDerivedStructData()
       Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
      .google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The derivedStructData.

    • getDerivedStructDataOrBuilder

      com.google.protobuf.StructOrBuilder getDerivedStructDataOrBuilder()
       Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
      .google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasPageSpan

      boolean hasPageSpan()
       Page span of the chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.PageSpan page_span = 6;
      Returns:
      Whether the pageSpan field is set.

    • getPageSpan

      Chunk.PageSpan getPageSpan()
       Page span of the chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.PageSpan page_span = 6;
      Returns:
      The pageSpan.

    • getPageSpanOrBuilder

      Chunk.PageSpanOrBuilder getPageSpanOrBuilder()
       Page span of the chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.PageSpan page_span = 6;

    • hasChunkMetadata

      boolean hasChunkMetadata()
       Output only. Metadata of the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the chunkMetadata field is set.

    • getChunkMetadata

      Chunk.ChunkMetadata getChunkMetadata()
       Output only. Metadata of the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The chunkMetadata.

    • getChunkMetadataOrBuilder

      Chunk.ChunkMetadataOrBuilder getChunkMetadataOrBuilder()
       Output only. Metadata of the current chunk.
      .google.cloud.discoveryengine.v1beta.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];