Package ai.pipestream.data.v1

Interface PipeDocOrBuilder

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

  • Method Details

    • getDocId

      String getDocId()
       Unique identifier for this document across the entire system.
 Deterministic: hash(datasource_id + source_doc_id)
      string doc_id = 1 [json_name = "docId"];
      Returns:
      The docId.

    • getDocIdBytes

      com.google.protobuf.ByteString getDocIdBytes()
       Unique identifier for this document across the entire system.
 Deterministic: hash(datasource_id + source_doc_id)
      string doc_id = 1 [json_name = "docId"];
      Returns:
      The bytes for docId.

    • hasSearchMetadata

      boolean hasSearchMetadata()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2 [json_name = "searchMetadata"];
      Returns:
      Whether the searchMetadata field is set.

    • getSearchMetadata

      SearchMetadata getSearchMetadata()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2 [json_name = "searchMetadata"];
      Returns:
      The searchMetadata.

    • getSearchMetadataOrBuilder

      SearchMetadataOrBuilder getSearchMetadataOrBuilder()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2 [json_name = "searchMetadata"];

    • hasBlobBag

      boolean hasBlobBag()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3 [json_name = "blobBag"];
      Returns:
      Whether the blobBag field is set.

    • getBlobBag

      BlobBag getBlobBag()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3 [json_name = "blobBag"];
      Returns:
      The blobBag.

    • getBlobBagOrBuilder

      BlobBagOrBuilder getBlobBagOrBuilder()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3 [json_name = "blobBag"];

    • hasStructuredData

      boolean hasStructuredData()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4 [json_name = "structuredData"];
      Returns:
      Whether the structuredData field is set.

    • getStructuredData

      com.google.protobuf.Any getStructuredData()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4 [json_name = "structuredData"];
      Returns:
      The structuredData.

    • getStructuredDataOrBuilder

      com.google.protobuf.AnyOrBuilder getStructuredDataOrBuilder()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4 [json_name = "structuredData"];

    • getParsedMetadataCount

      int getParsedMetadataCount()
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5 [json_name = "parsedMetadata"];

    • containsParsedMetadata

      boolean containsParsedMetadata(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5 [json_name = "parsedMetadata"];

    • getParsedMetadata

      @Deprecated Map<String,ParsedMetadata> getParsedMetadata()
      Deprecated.
      Use getParsedMetadataMap() instead.

    • getParsedMetadataMap

      Map<String,ParsedMetadata> getParsedMetadataMap()
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5 [json_name = "parsedMetadata"];

    • getParsedMetadataOrDefault

      ParsedMetadata getParsedMetadataOrDefault(String key, ParsedMetadata defaultValue)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5 [json_name = "parsedMetadata"];

    • getParsedMetadataOrThrow

      ParsedMetadata getParsedMetadataOrThrow(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5 [json_name = "parsedMetadata"];

    • hasOwnership

      boolean hasOwnership()
       Ownership tracking for security, auditing, and access control.

 Captures which account and datasource produced this document.
      optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];
      Returns:
      Whether the ownership field is set.

    • getOwnership

      OwnershipContext getOwnership()
       Ownership tracking for security, auditing, and access control.

 Captures which account and datasource produced this document.
      optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];
      Returns:
      The ownership.

    • getOwnershipOrBuilder

      OwnershipContextOrBuilder getOwnershipOrBuilder()
       Ownership tracking for security, auditing, and access control.

 Captures which account and datasource produced this document.
      optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];