Package com.google.cloud.aiplatform.v1

Interface RagContexts.ContextOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RagContexts.Context, RagContexts.Context.Builder
Enclosing class:
RagContexts
public static interface RagContexts.ContextOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    RagChunk
    getChunk()
    Context of the retrieved chunk.
    RagChunkOrBuilder
    getChunkOrBuilder()
    Context of the retrieved chunk.
    double
    getScore()
    According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type.
    String
    getSourceDisplayName()
    The file display name.
    com.google.protobuf.ByteString
    getSourceDisplayNameBytes()
    The file display name.
    String
    getSourceUri()
    If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
    com.google.protobuf.ByteString
    getSourceUriBytes()
    If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
    String
    getText()
    The text chunk.
    com.google.protobuf.ByteString
    getTextBytes()
    The text chunk.
    boolean
    hasChunk()
    Context of the retrieved chunk.
    boolean
    hasScore()
    According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSourceUri

      String getSourceUri()
       If the file is imported from Cloud Storage or Google Drive, source_uri
 will be original file URI in Cloud Storage or Google Drive; if file is
 uploaded, source_uri will be file display name.
      string source_uri = 1;
      Returns:
      The sourceUri.

    • getSourceUriBytes

      com.google.protobuf.ByteString getSourceUriBytes()
       If the file is imported from Cloud Storage or Google Drive, source_uri
 will be original file URI in Cloud Storage or Google Drive; if file is
 uploaded, source_uri will be file display name.
      string source_uri = 1;
      Returns:
      The bytes for sourceUri.

    • getSourceDisplayName

      String getSourceDisplayName()
       The file display name.
      string source_display_name = 5;
      Returns:
      The sourceDisplayName.

    • getSourceDisplayNameBytes

      com.google.protobuf.ByteString getSourceDisplayNameBytes()
       The file display name.
      string source_display_name = 5;
      Returns:
      The bytes for sourceDisplayName.

    • getText

      String getText()
       The text chunk.
      string text = 2;
      Returns:
      The text.

    • getTextBytes

      com.google.protobuf.ByteString getTextBytes()
       The text chunk.
      string text = 2;
      Returns:
      The bytes for text.

    • hasScore

      boolean hasScore()
       According to the underlying Vector DB and the selected metric type, the
 score can be either the distance or the similarity between the query and
 the context and its range depends on the metric type.

 For example, if the metric type is COSINE_DISTANCE, it represents the
 distance between the query and the context. The larger the distance, the
 less relevant the context is to the query. The range is [0, 2], while 0
 means the most relevant and 2 means the least relevant.
      optional double score = 6;
      Returns:
      Whether the score field is set.

    • getScore

      double getScore()
       According to the underlying Vector DB and the selected metric type, the
 score can be either the distance or the similarity between the query and
 the context and its range depends on the metric type.

 For example, if the metric type is COSINE_DISTANCE, it represents the
 distance between the query and the context. The larger the distance, the
 less relevant the context is to the query. The range is [0, 2], while 0
 means the most relevant and 2 means the least relevant.
      optional double score = 6;
      Returns:
      The score.

    • hasChunk

      boolean hasChunk()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Returns:
      Whether the chunk field is set.

    • getChunk

      RagChunk getChunk()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Returns:
      The chunk.

    • getChunkOrBuilder

      RagChunkOrBuilder getChunkOrBuilder()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;