Package ai.pipestream.data.v1

Interface SemanticChunkOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Chunk-specific metadata (e.g., page number, section).
    String
    getChunkId()
    Unique identifier for this chunk within its parent result.
    com.google.protobuf.ByteString
    getChunkIdBytes()
    Unique identifier for this chunk within its parent result.
    long
    getChunkNumber()
    Sequential number of this chunk within its parent result.
    ChunkEmbedding
    getEmbeddingInfo()
    Text and embedding information for this chunk.
    ChunkEmbeddingOrBuilder
    getEmbeddingInfoOrBuilder()
    Text and embedding information for this chunk.
    Map<String,com.google.protobuf.Value>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Chunk-specific metadata (e.g., page number, section).
    Map<String,com.google.protobuf.Value>
    getMetadataMap()
    Chunk-specific metadata (e.g., page number, section).
    com.google.protobuf.Value
    getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
    Chunk-specific metadata (e.g., page number, section).
    com.google.protobuf.Value
    getMetadataOrThrow(String key)
    Chunk-specific metadata (e.g., page number, section).
    boolean
    hasEmbeddingInfo()
    Text and embedding information for this chunk.

    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

    • getChunkId

      String getChunkId()
       Unique identifier for this chunk within its parent result.
      string chunk_id = 1 [json_name = "chunkId"];
      Returns:
      The chunkId.

    • getChunkIdBytes

      com.google.protobuf.ByteString getChunkIdBytes()
       Unique identifier for this chunk within its parent result.
      string chunk_id = 1 [json_name = "chunkId"];
      Returns:
      The bytes for chunkId.

    • getChunkNumber

      long getChunkNumber()
       Sequential number of this chunk within its parent result.
      int64 chunk_number = 2 [json_name = "chunkNumber"];
      Returns:
      The chunkNumber.

    • hasEmbeddingInfo

      boolean hasEmbeddingInfo()
       Text and embedding information for this chunk.
      .ai.pipestream.data.v1.ChunkEmbedding embedding_info = 3 [json_name = "embeddingInfo"];
      Returns:
      Whether the embeddingInfo field is set.

    • getEmbeddingInfo

      ChunkEmbedding getEmbeddingInfo()
       Text and embedding information for this chunk.
      .ai.pipestream.data.v1.ChunkEmbedding embedding_info = 3 [json_name = "embeddingInfo"];
      Returns:
      The embeddingInfo.

    • getEmbeddingInfoOrBuilder

      ChunkEmbeddingOrBuilder getEmbeddingInfoOrBuilder()
       Text and embedding information for this chunk.
      .ai.pipestream.data.v1.ChunkEmbedding embedding_info = 3 [json_name = "embeddingInfo"];

    • getMetadataCount

      int getMetadataCount()
       Chunk-specific metadata (e.g., page number, section).
      map<string, .google.protobuf.Value> metadata = 4 [json_name = "metadata"];

    • containsMetadata

      boolean containsMetadata(String key)
       Chunk-specific metadata (e.g., page number, section).
      map<string, .google.protobuf.Value> metadata = 4 [json_name = "metadata"];

    • getMetadata

      @Deprecated Map<String,com.google.protobuf.Value> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,com.google.protobuf.Value> getMetadataMap()
       Chunk-specific metadata (e.g., page number, section).
      map<string, .google.protobuf.Value> metadata = 4 [json_name = "metadata"];

    • getMetadataOrDefault

      com.google.protobuf.Value getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
       Chunk-specific metadata (e.g., page number, section).
      map<string, .google.protobuf.Value> metadata = 4 [json_name = "metadata"];

    • getMetadataOrThrow

      com.google.protobuf.Value getMetadataOrThrow(String key)
       Chunk-specific metadata (e.g., page number, section).
      map<string, .google.protobuf.Value> metadata = 4 [json_name = "metadata"];