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 Summary

    Modifier and Type
    Method
    Description
    BlobBag
    getBlobBag()
    Binary content container for document parsing.
    BlobBagOrBuilder
    getBlobBagOrBuilder()
    Binary content container for document parsing.
    String
    getDocId()
    Unique identifier for this document across the entire system.
    com.google.protobuf.ByteString
    getDocIdBytes()
    Unique identifier for this document across the entire system.
    SearchMetadata
    getSearchMetadata()
    Standardized search engine metadata for OOTB indexing and querying.
    SearchMetadataOrBuilder
    getSearchMetadataOrBuilder()
    Standardized search engine metadata for OOTB indexing and querying.
    com.google.protobuf.Any
    getStructuredData()
    Customer-provided structured data in any protobuf format.
    com.google.protobuf.AnyOrBuilder
    getStructuredDataOrBuilder()
    Customer-provided structured data in any protobuf format.
    boolean
    hasBlobBag()
    Binary content container for document parsing.
    boolean
    hasSearchMetadata()
    Standardized search engine metadata for OOTB indexing and querying.
    boolean
    hasStructuredData()
    Customer-provided structured data in any protobuf format.

    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

    • getDocId

      String getDocId()
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Returns:
      The docId.

    • getDocIdBytes

      com.google.protobuf.ByteString getDocIdBytes()
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      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;
      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;
      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;

    • 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;
      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;
      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;

    • 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;
      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;
      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;