Package ai.pipestream.data.v1

Interface SemanticProcessingResultOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Processing run metadata (e.g., model version, execution time).
    String
    getChunkConfigId()
    Identifier for the chunking configuration used.
    com.google.protobuf.ByteString
    getChunkConfigIdBytes()
    Identifier for the chunking configuration used.
    SemanticChunk
    getChunks(int index)
    List of semantic chunks with embeddings from this configuration.
    int
    getChunksCount()
    List of semantic chunks with embeddings from this configuration.
    List<SemanticChunk>
    getChunksList()
    List of semantic chunks with embeddings from this configuration.
    SemanticChunkOrBuilder
    getChunksOrBuilder(int index)
    List of semantic chunks with embeddings from this configuration.
    List<? extends SemanticChunkOrBuilder>
    getChunksOrBuilderList()
    List of semantic chunks with embeddings from this configuration.
    String
    getEmbeddingConfigId()
    Identifier for the embedding model/configuration used.
    com.google.protobuf.ByteString
    getEmbeddingConfigIdBytes()
    Identifier for the embedding model/configuration used.
    Map<String,com.google.protobuf.Value>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Processing run metadata (e.g., model version, execution time).
    Map<String,com.google.protobuf.Value>
    getMetadataMap()
    Processing run metadata (e.g., model version, execution time).
    com.google.protobuf.Value
    getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
    Processing run metadata (e.g., model version, execution time).
    com.google.protobuf.Value
    getMetadataOrThrow(String key)
    Processing run metadata (e.g., model version, execution time).
    String
    getResultId()
    Unique identifier for this result set.
    com.google.protobuf.ByteString
    getResultIdBytes()
    Unique identifier for this result set.
    String
    getResultSetName()
    Generated name for this result set.
    com.google.protobuf.ByteString
    getResultSetNameBytes()
    Generated name for this result set.
    String
    getSourceFieldName()
    Name of the PipeDoc field that was processed.
    com.google.protobuf.ByteString
    getSourceFieldNameBytes()
    Name of the PipeDoc field that was processed.
    boolean
    hasResultSetName()
    Generated name for this result set.

    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

    • getResultId

      String getResultId()
       Unique identifier for this result set.
      string result_id = 1 [json_name = "resultId"];
      Returns:
      The resultId.

    • getResultIdBytes

      com.google.protobuf.ByteString getResultIdBytes()
       Unique identifier for this result set.
      string result_id = 1 [json_name = "resultId"];
      Returns:
      The bytes for resultId.

    • getSourceFieldName

      String getSourceFieldName()
       Name of the PipeDoc field that was processed.

 Examples: "body", "title", "abstract"
      string source_field_name = 2 [json_name = "sourceFieldName"];
      Returns:
      The sourceFieldName.

    • getSourceFieldNameBytes

      com.google.protobuf.ByteString getSourceFieldNameBytes()
       Name of the PipeDoc field that was processed.

 Examples: "body", "title", "abstract"
      string source_field_name = 2 [json_name = "sourceFieldName"];
      Returns:
      The bytes for sourceFieldName.

    • getChunkConfigId

      String getChunkConfigId()
       Identifier for the chunking configuration used.

 Examples: "sentence_splitter_v1", "token_chunker_512_overlap_50"
      string chunk_config_id = 3 [json_name = "chunkConfigId"];
      Returns:
      The chunkConfigId.

    • getChunkConfigIdBytes

      com.google.protobuf.ByteString getChunkConfigIdBytes()
       Identifier for the chunking configuration used.

 Examples: "sentence_splitter_v1", "token_chunker_512_overlap_50"
      string chunk_config_id = 3 [json_name = "chunkConfigId"];
      Returns:
      The bytes for chunkConfigId.

    • getEmbeddingConfigId

      String getEmbeddingConfigId()
       Identifier for the embedding model/configuration used.

 Examples: "ada_002_v1", "minilm_l6_v1"
      string embedding_config_id = 4 [json_name = "embeddingConfigId"];
      Returns:
      The embeddingConfigId.

    • getEmbeddingConfigIdBytes

      com.google.protobuf.ByteString getEmbeddingConfigIdBytes()
       Identifier for the embedding model/configuration used.

 Examples: "ada_002_v1", "minilm_l6_v1"
      string embedding_config_id = 4 [json_name = "embeddingConfigId"];
      Returns:
      The bytes for embeddingConfigId.

    • hasResultSetName

      boolean hasResultSetName()
       Generated name for this result set.

 Used as field name prefix in search indexes or for UI display/selection.
 Examples: "body_chunks_ada_002", "title_sentences_minilm"
      optional string result_set_name = 5 [json_name = "resultSetName"];
      Returns:
      Whether the resultSetName field is set.

    • getResultSetName

      String getResultSetName()
       Generated name for this result set.

 Used as field name prefix in search indexes or for UI display/selection.
 Examples: "body_chunks_ada_002", "title_sentences_minilm"
      optional string result_set_name = 5 [json_name = "resultSetName"];
      Returns:
      The resultSetName.

    • getResultSetNameBytes

      com.google.protobuf.ByteString getResultSetNameBytes()
       Generated name for this result set.

 Used as field name prefix in search indexes or for UI display/selection.
 Examples: "body_chunks_ada_002", "title_sentences_minilm"
      optional string result_set_name = 5 [json_name = "resultSetName"];
      Returns:
      The bytes for resultSetName.

    • getChunksList

      List<SemanticChunk> getChunksList()
       List of semantic chunks with embeddings from this configuration.
      repeated .ai.pipestream.data.v1.SemanticChunk chunks = 6 [json_name = "chunks"];

    • getChunks

      SemanticChunk getChunks(int index)
       List of semantic chunks with embeddings from this configuration.
      repeated .ai.pipestream.data.v1.SemanticChunk chunks = 6 [json_name = "chunks"];

    • getChunksCount

      int getChunksCount()
       List of semantic chunks with embeddings from this configuration.
      repeated .ai.pipestream.data.v1.SemanticChunk chunks = 6 [json_name = "chunks"];

    • getChunksOrBuilderList

      List<? extends SemanticChunkOrBuilder> getChunksOrBuilderList()
       List of semantic chunks with embeddings from this configuration.
      repeated .ai.pipestream.data.v1.SemanticChunk chunks = 6 [json_name = "chunks"];

    • getChunksOrBuilder

      SemanticChunkOrBuilder getChunksOrBuilder(int index)
       List of semantic chunks with embeddings from this configuration.
      repeated .ai.pipestream.data.v1.SemanticChunk chunks = 6 [json_name = "chunks"];

    • getMetadataCount

      int getMetadataCount()
       Processing run metadata (e.g., model version, execution time).
      map<string, .google.protobuf.Value> metadata = 7 [json_name = "metadata"];

    • containsMetadata

      boolean containsMetadata(String key)
       Processing run metadata (e.g., model version, execution time).
      map<string, .google.protobuf.Value> metadata = 7 [json_name = "metadata"];

    • getMetadata

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

    • getMetadataMap

      Map<String,com.google.protobuf.Value> getMetadataMap()
       Processing run metadata (e.g., model version, execution time).
      map<string, .google.protobuf.Value> metadata = 7 [json_name = "metadata"];

    • getMetadataOrDefault

      com.google.protobuf.Value getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
       Processing run metadata (e.g., model version, execution time).
      map<string, .google.protobuf.Value> metadata = 7 [json_name = "metadata"];

    • getMetadataOrThrow

      com.google.protobuf.Value getMetadataOrThrow(String key)
       Processing run metadata (e.g., model version, execution time).
      map<string, .google.protobuf.Value> metadata = 7 [json_name = "metadata"];