Package ai.pipestream.data.v1
Class SearchMetadata
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.data.v1.SearchMetadata
- All Implemented Interfaces:
SearchMetadataOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class SearchMetadata
extends com.google.protobuf.GeneratedMessage
implements SearchMetadataOrBuilder
Standardized search engine metadata for OOTB indexing. Provides a common data layout for search API queries. This structure maintains consistency across different document types while supporting enhanced search features like semantic chunking, document outlines, and link extraction.Protobuf type
ai.pipestream.data.v1.SearchMetadata- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classStandardized search engine metadata for OOTB indexing.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsMetadata(String key) Generic key-value metadata for extensibility.booleanDocument author or creator.com.google.protobuf.ByteStringDocument author or creator.getBody()Full text content of the document.com.google.protobuf.ByteStringFull text content of the document.Category or classification label for the document.com.google.protobuf.ByteStringCategory or classification label for the document.intLength of the document content in bytes or characters.com.google.protobuf.TimestampTimestamp when the document was originally created.com.google.protobuf.TimestampOrBuilderTimestamp when the document was originally created.com.google.protobuf.StructAdditional custom fields not covered by standard schema.com.google.protobuf.StructOrBuilderAdditional custom fields not covered by standard schema.static SearchMetadatastatic final com.google.protobuf.Descriptors.DescriptorgetDiscoveredLinks(int index) Links discovered within the document.intLinks discovered within the document.Links discovered within the document.getDiscoveredLinksOrBuilder(int index) Links discovered within the document.List<? extends LinkReferenceOrBuilder> Links discovered within the document.Neutral document outline for navigation and chunking.Neutral document outline for navigation and chunking.Document type classification (e.g., "PDF", "HTML", "DOCX").com.google.protobuf.ByteStringDocument type classification (e.g., "PDF", "HTML", "DOCX").getDoi()Digital Object Identifier for academic papers and publications.com.google.protobuf.ByteStringDigital Object Identifier for academic papers and publications.Extracted keywords for search and categorization.Extracted keywords for search and categorization.Language code of the document content (e.g., "en", "es", "fr").com.google.protobuf.ByteStringLanguage code of the document content (e.g., "en", "es", "fr").com.google.protobuf.TimestampTimestamp when the document was last modified at source.com.google.protobuf.TimestampOrBuilderTimestamp when the document was last modified at source.Deprecated.intGeneric key-value metadata for extensibility.Generic key-value metadata for extensibility.getMetadataOrDefault(String key, String defaultValue) Generic key-value metadata for extensibility.getMetadataOrThrow(String key) Generic key-value metadata for extensibility.com.google.protobuf.Parser<SearchMetadata> com.google.protobuf.TimestampTimestamp when the document was processed by the pipeline.com.google.protobuf.TimestampOrBuilderTimestamp when the document was processed by the pipeline.doubleRelevance score for search ranking purposes.getSemanticResults(int index) Results from semantic chunking and embedding processes.intResults from semantic chunking and embedding processes.Results from semantic chunking and embedding processes.getSemanticResultsOrBuilder(int index) Results from semantic chunking and embedding processes.List<? extends SemanticProcessingResultOrBuilder> Results from semantic chunking and embedding processes.intMIME type of the source document.com.google.protobuf.ByteStringMIME type of the source document.Path portion of source_uri for categorization.com.google.protobuf.ByteStringPath portion of source_uri for categorization.getSourcePathSegments(int index) Split path segments from source_path.com.google.protobuf.ByteStringgetSourcePathSegmentsBytes(int index) Split path segments from source_path.intSplit path segments from source_path.com.google.protobuf.ProtocolStringListSplit path segments from source_path.Last segment of source_path.com.google.protobuf.ByteStringLast segment of source_path.Original source URI where the document was obtained.com.google.protobuf.ByteStringOriginal source URI where the document was obtained.getTags()Key-value tags for flexible categorization.Key-value tags for flexible categorization.getTitle()Document title or heading.com.google.protobuf.ByteStringDocument title or heading.booleanDocument author or creator.booleanhasBody()Full text content of the document.booleanCategory or classification label for the document.booleanLength of the document content in bytes or characters.booleanTimestamp when the document was originally created.booleanAdditional custom fields not covered by standard schema.booleanNeutral document outline for navigation and chunking.booleanDocument type classification (e.g., "PDF", "HTML", "DOCX").booleanhasDoi()Digital Object Identifier for academic papers and publications.inthashCode()booleanExtracted keywords for search and categorization.booleanLanguage code of the document content (e.g., "en", "es", "fr").booleanTimestamp when the document was last modified at source.booleanTimestamp when the document was processed by the pipeline.booleanRelevance score for search ranking purposes.booleanMIME type of the source document.booleanPath portion of source_uri for categorization.booleanLast segment of source_path.booleanOriginal source URI where the document was obtained.booleanhasTags()Key-value tags for flexible categorization.booleanhasTitle()Document title or heading.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic SearchMetadata.Builderstatic SearchMetadata.BuildernewBuilder(SearchMetadata prototype) protected SearchMetadata.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static SearchMetadataparseDelimitedFrom(InputStream input) static SearchMetadataparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchMetadataparseFrom(byte[] data) static SearchMetadataparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchMetadataparseFrom(com.google.protobuf.ByteString data) static SearchMetadataparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchMetadataparseFrom(com.google.protobuf.CodedInputStream input) static SearchMetadataparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchMetadataparseFrom(InputStream input) static SearchMetadataparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchMetadataparseFrom(ByteBuffer data) static SearchMetadataparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<SearchMetadata> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER- See Also:
-
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER- See Also:
-
KEYWORDS_FIELD_NUMBER
public static final int KEYWORDS_FIELD_NUMBER- See Also:
-
DOCUMENT_TYPE_FIELD_NUMBER
public static final int DOCUMENT_TYPE_FIELD_NUMBER- See Also:
-
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER- See Also:
-
SOURCE_MIME_TYPE_FIELD_NUMBER
public static final int SOURCE_MIME_TYPE_FIELD_NUMBER- See Also:
-
CREATION_DATE_FIELD_NUMBER
public static final int CREATION_DATE_FIELD_NUMBER- See Also:
-
LAST_MODIFIED_DATE_FIELD_NUMBER
public static final int LAST_MODIFIED_DATE_FIELD_NUMBER- See Also:
-
PROCESSED_DATE_FIELD_NUMBER
public static final int PROCESSED_DATE_FIELD_NUMBER- See Also:
-
LANGUAGE_FIELD_NUMBER
public static final int LANGUAGE_FIELD_NUMBER- See Also:
-
AUTHOR_FIELD_NUMBER
public static final int AUTHOR_FIELD_NUMBER- See Also:
-
CATEGORY_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
CONTENT_LENGTH_FIELD_NUMBER
public static final int CONTENT_LENGTH_FIELD_NUMBER- See Also:
-
RELEVANCE_SCORE_FIELD_NUMBER
public static final int RELEVANCE_SCORE_FIELD_NUMBER- See Also:
-
CUSTOM_FIELDS_FIELD_NUMBER
public static final int CUSTOM_FIELDS_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
SEMANTIC_RESULTS_FIELD_NUMBER
public static final int SEMANTIC_RESULTS_FIELD_NUMBER- See Also:
-
DOI_FIELD_NUMBER
public static final int DOI_FIELD_NUMBER- See Also:
-
DOC_OUTLINE_FIELD_NUMBER
public static final int DOC_OUTLINE_FIELD_NUMBER- See Also:
-
DISCOVERED_LINKS_FIELD_NUMBER
public static final int DISCOVERED_LINKS_FIELD_NUMBER- See Also:
-
SOURCE_PATH_FIELD_NUMBER
public static final int SOURCE_PATH_FIELD_NUMBER- See Also:
-
SOURCE_PATH_SEGMENTS_FIELD_NUMBER
public static final int SOURCE_PATH_SEGMENTS_FIELD_NUMBER- See Also:
-
SOURCE_SLUG_FIELD_NUMBER
public static final int SOURCE_SLUG_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
hasTitle
public boolean hasTitle()Document title or heading.
optional string title = 1 [json_name = "title"];- Specified by:
hasTitlein interfaceSearchMetadataOrBuilder- Returns:
- Whether the title field is set.
-
getTitle
Document title or heading.
optional string title = 1 [json_name = "title"];- Specified by:
getTitlein interfaceSearchMetadataOrBuilder- Returns:
- The title.
-
getTitleBytes
public com.google.protobuf.ByteString getTitleBytes()Document title or heading.
optional string title = 1 [json_name = "title"];- Specified by:
getTitleBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for title.
-
hasBody
public boolean hasBody()Full text content of the document.
optional string body = 2 [json_name = "body"];- Specified by:
hasBodyin interfaceSearchMetadataOrBuilder- Returns:
- Whether the body field is set.
-
getBody
Full text content of the document.
optional string body = 2 [json_name = "body"];- Specified by:
getBodyin interfaceSearchMetadataOrBuilder- Returns:
- The body.
-
getBodyBytes
public com.google.protobuf.ByteString getBodyBytes()Full text content of the document.
optional string body = 2 [json_name = "body"];- Specified by:
getBodyBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for body.
-
hasKeywords
public boolean hasKeywords()Extracted keywords for search and categorization.
optional .ai.pipestream.data.v1.Keywords keywords = 3 [json_name = "keywords"];- Specified by:
hasKeywordsin interfaceSearchMetadataOrBuilder- Returns:
- Whether the keywords field is set.
-
getKeywords
Extracted keywords for search and categorization.
optional .ai.pipestream.data.v1.Keywords keywords = 3 [json_name = "keywords"];- Specified by:
getKeywordsin interfaceSearchMetadataOrBuilder- Returns:
- The keywords.
-
getKeywordsOrBuilder
Extracted keywords for search and categorization.
optional .ai.pipestream.data.v1.Keywords keywords = 3 [json_name = "keywords"];- Specified by:
getKeywordsOrBuilderin interfaceSearchMetadataOrBuilder
-
hasDocumentType
public boolean hasDocumentType()Document type classification (e.g., "PDF", "HTML", "DOCX").
optional string document_type = 4 [json_name = "documentType"];- Specified by:
hasDocumentTypein interfaceSearchMetadataOrBuilder- Returns:
- Whether the documentType field is set.
-
getDocumentType
Document type classification (e.g., "PDF", "HTML", "DOCX").
optional string document_type = 4 [json_name = "documentType"];- Specified by:
getDocumentTypein interfaceSearchMetadataOrBuilder- Returns:
- The documentType.
-
getDocumentTypeBytes
public com.google.protobuf.ByteString getDocumentTypeBytes()Document type classification (e.g., "PDF", "HTML", "DOCX").
optional string document_type = 4 [json_name = "documentType"];- Specified by:
getDocumentTypeBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for documentType.
-
hasSourceUri
public boolean hasSourceUri()Original source URI where the document was obtained.
optional string source_uri = 5 [json_name = "sourceUri"];- Specified by:
hasSourceUriin interfaceSearchMetadataOrBuilder- Returns:
- Whether the sourceUri field is set.
-
getSourceUri
Original source URI where the document was obtained.
optional string source_uri = 5 [json_name = "sourceUri"];- Specified by:
getSourceUriin interfaceSearchMetadataOrBuilder- Returns:
- The sourceUri.
-
getSourceUriBytes
public com.google.protobuf.ByteString getSourceUriBytes()Original source URI where the document was obtained.
optional string source_uri = 5 [json_name = "sourceUri"];- Specified by:
getSourceUriBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for sourceUri.
-
hasSourceMimeType
public boolean hasSourceMimeType()MIME type of the source document.
optional string source_mime_type = 6 [json_name = "sourceMimeType"];- Specified by:
hasSourceMimeTypein interfaceSearchMetadataOrBuilder- Returns:
- Whether the sourceMimeType field is set.
-
getSourceMimeType
MIME type of the source document.
optional string source_mime_type = 6 [json_name = "sourceMimeType"];- Specified by:
getSourceMimeTypein interfaceSearchMetadataOrBuilder- Returns:
- The sourceMimeType.
-
getSourceMimeTypeBytes
public com.google.protobuf.ByteString getSourceMimeTypeBytes()MIME type of the source document.
optional string source_mime_type = 6 [json_name = "sourceMimeType"];- Specified by:
getSourceMimeTypeBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for sourceMimeType.
-
hasCreationDate
public boolean hasCreationDate()Timestamp when the document was originally created.
optional .google.protobuf.Timestamp creation_date = 7 [json_name = "creationDate"];- Specified by:
hasCreationDatein interfaceSearchMetadataOrBuilder- Returns:
- Whether the creationDate field is set.
-
getCreationDate
public com.google.protobuf.Timestamp getCreationDate()Timestamp when the document was originally created.
optional .google.protobuf.Timestamp creation_date = 7 [json_name = "creationDate"];- Specified by:
getCreationDatein interfaceSearchMetadataOrBuilder- Returns:
- The creationDate.
-
getCreationDateOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreationDateOrBuilder()Timestamp when the document was originally created.
optional .google.protobuf.Timestamp creation_date = 7 [json_name = "creationDate"];- Specified by:
getCreationDateOrBuilderin interfaceSearchMetadataOrBuilder
-
hasLastModifiedDate
public boolean hasLastModifiedDate()Timestamp when the document was last modified at source.
optional .google.protobuf.Timestamp last_modified_date = 8 [json_name = "lastModifiedDate"];- Specified by:
hasLastModifiedDatein interfaceSearchMetadataOrBuilder- Returns:
- Whether the lastModifiedDate field is set.
-
getLastModifiedDate
public com.google.protobuf.Timestamp getLastModifiedDate()Timestamp when the document was last modified at source.
optional .google.protobuf.Timestamp last_modified_date = 8 [json_name = "lastModifiedDate"];- Specified by:
getLastModifiedDatein interfaceSearchMetadataOrBuilder- Returns:
- The lastModifiedDate.
-
getLastModifiedDateOrBuilder
public com.google.protobuf.TimestampOrBuilder getLastModifiedDateOrBuilder()Timestamp when the document was last modified at source.
optional .google.protobuf.Timestamp last_modified_date = 8 [json_name = "lastModifiedDate"];- Specified by:
getLastModifiedDateOrBuilderin interfaceSearchMetadataOrBuilder
-
hasProcessedDate
public boolean hasProcessedDate()Timestamp when the document was processed by the pipeline.
optional .google.protobuf.Timestamp processed_date = 9 [json_name = "processedDate"];- Specified by:
hasProcessedDatein interfaceSearchMetadataOrBuilder- Returns:
- Whether the processedDate field is set.
-
getProcessedDate
public com.google.protobuf.Timestamp getProcessedDate()Timestamp when the document was processed by the pipeline.
optional .google.protobuf.Timestamp processed_date = 9 [json_name = "processedDate"];- Specified by:
getProcessedDatein interfaceSearchMetadataOrBuilder- Returns:
- The processedDate.
-
getProcessedDateOrBuilder
public com.google.protobuf.TimestampOrBuilder getProcessedDateOrBuilder()Timestamp when the document was processed by the pipeline.
optional .google.protobuf.Timestamp processed_date = 9 [json_name = "processedDate"];- Specified by:
getProcessedDateOrBuilderin interfaceSearchMetadataOrBuilder
-
hasLanguage
public boolean hasLanguage()Language code of the document content (e.g., "en", "es", "fr").
optional string language = 10 [json_name = "language"];- Specified by:
hasLanguagein interfaceSearchMetadataOrBuilder- Returns:
- Whether the language field is set.
-
getLanguage
Language code of the document content (e.g., "en", "es", "fr").
optional string language = 10 [json_name = "language"];- Specified by:
getLanguagein interfaceSearchMetadataOrBuilder- Returns:
- The language.
-
getLanguageBytes
public com.google.protobuf.ByteString getLanguageBytes()Language code of the document content (e.g., "en", "es", "fr").
optional string language = 10 [json_name = "language"];- Specified by:
getLanguageBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for language.
-
hasAuthor
public boolean hasAuthor()Document author or creator.
optional string author = 11 [json_name = "author"];- Specified by:
hasAuthorin interfaceSearchMetadataOrBuilder- Returns:
- Whether the author field is set.
-
getAuthor
Document author or creator.
optional string author = 11 [json_name = "author"];- Specified by:
getAuthorin interfaceSearchMetadataOrBuilder- Returns:
- The author.
-
getAuthorBytes
public com.google.protobuf.ByteString getAuthorBytes()Document author or creator.
optional string author = 11 [json_name = "author"];- Specified by:
getAuthorBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for author.
-
hasCategory
public boolean hasCategory()Category or classification label for the document.
optional string category = 12 [json_name = "category"];- Specified by:
hasCategoryin interfaceSearchMetadataOrBuilder- Returns:
- Whether the category field is set.
-
getCategory
Category or classification label for the document.
optional string category = 12 [json_name = "category"];- Specified by:
getCategoryin interfaceSearchMetadataOrBuilder- Returns:
- The category.
-
getCategoryBytes
public com.google.protobuf.ByteString getCategoryBytes()Category or classification label for the document.
optional string category = 12 [json_name = "category"];- Specified by:
getCategoryBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for category.
-
hasTags
public boolean hasTags()Key-value tags for flexible categorization.
optional .ai.pipestream.data.v1.Tags tags = 13 [json_name = "tags"];- Specified by:
hasTagsin interfaceSearchMetadataOrBuilder- Returns:
- Whether the tags field is set.
-
getTags
Key-value tags for flexible categorization.
optional .ai.pipestream.data.v1.Tags tags = 13 [json_name = "tags"];- Specified by:
getTagsin interfaceSearchMetadataOrBuilder- Returns:
- The tags.
-
getTagsOrBuilder
Key-value tags for flexible categorization.
optional .ai.pipestream.data.v1.Tags tags = 13 [json_name = "tags"];- Specified by:
getTagsOrBuilderin interfaceSearchMetadataOrBuilder
-
hasContentLength
public boolean hasContentLength()Length of the document content in bytes or characters.
optional int32 content_length = 14 [json_name = "contentLength"];- Specified by:
hasContentLengthin interfaceSearchMetadataOrBuilder- Returns:
- Whether the contentLength field is set.
-
getContentLength
public int getContentLength()Length of the document content in bytes or characters.
optional int32 content_length = 14 [json_name = "contentLength"];- Specified by:
getContentLengthin interfaceSearchMetadataOrBuilder- Returns:
- The contentLength.
-
hasRelevanceScore
public boolean hasRelevanceScore()Relevance score for search ranking purposes.
optional double relevance_score = 15 [json_name = "relevanceScore"];- Specified by:
hasRelevanceScorein interfaceSearchMetadataOrBuilder- Returns:
- Whether the relevanceScore field is set.
-
getRelevanceScore
public double getRelevanceScore()Relevance score for search ranking purposes.
optional double relevance_score = 15 [json_name = "relevanceScore"];- Specified by:
getRelevanceScorein interfaceSearchMetadataOrBuilder- Returns:
- The relevanceScore.
-
hasCustomFields
public boolean hasCustomFields()Additional custom fields not covered by standard schema.
optional .google.protobuf.Struct custom_fields = 16 [json_name = "customFields"];- Specified by:
hasCustomFieldsin interfaceSearchMetadataOrBuilder- Returns:
- Whether the customFields field is set.
-
getCustomFields
public com.google.protobuf.Struct getCustomFields()Additional custom fields not covered by standard schema.
optional .google.protobuf.Struct custom_fields = 16 [json_name = "customFields"];- Specified by:
getCustomFieldsin interfaceSearchMetadataOrBuilder- Returns:
- The customFields.
-
getCustomFieldsOrBuilder
public com.google.protobuf.StructOrBuilder getCustomFieldsOrBuilder()Additional custom fields not covered by standard schema.
optional .google.protobuf.Struct custom_fields = 16 [json_name = "customFields"];- Specified by:
getCustomFieldsOrBuilderin interfaceSearchMetadataOrBuilder
-
getMetadataCount
public int getMetadataCount()Description copied from interface:SearchMetadataOrBuilderGeneric key-value metadata for extensibility.
map<string, string> metadata = 17 [json_name = "metadata"];- Specified by:
getMetadataCountin interfaceSearchMetadataOrBuilder
-
containsMetadata
Generic key-value metadata for extensibility.
map<string, string> metadata = 17 [json_name = "metadata"];- Specified by:
containsMetadatain interfaceSearchMetadataOrBuilder
-
getMetadata
Deprecated.UsegetMetadataMap()instead.- Specified by:
getMetadatain interfaceSearchMetadataOrBuilder
-
getMetadataMap
Generic key-value metadata for extensibility.
map<string, string> metadata = 17 [json_name = "metadata"];- Specified by:
getMetadataMapin interfaceSearchMetadataOrBuilder
-
getMetadataOrDefault
Generic key-value metadata for extensibility.
map<string, string> metadata = 17 [json_name = "metadata"];- Specified by:
getMetadataOrDefaultin interfaceSearchMetadataOrBuilder
-
getMetadataOrThrow
Generic key-value metadata for extensibility.
map<string, string> metadata = 17 [json_name = "metadata"];- Specified by:
getMetadataOrThrowin interfaceSearchMetadataOrBuilder
-
getSemanticResultsList
Results from semantic chunking and embedding processes. Supports multiple processing configurations applied to the same document.
repeated .ai.pipestream.data.v1.SemanticProcessingResult semantic_results = 18 [json_name = "semanticResults"];- Specified by:
getSemanticResultsListin interfaceSearchMetadataOrBuilder
-
getSemanticResultsOrBuilderList
Results from semantic chunking and embedding processes. Supports multiple processing configurations applied to the same document.
repeated .ai.pipestream.data.v1.SemanticProcessingResult semantic_results = 18 [json_name = "semanticResults"];- Specified by:
getSemanticResultsOrBuilderListin interfaceSearchMetadataOrBuilder
-
getSemanticResultsCount
public int getSemanticResultsCount()Results from semantic chunking and embedding processes. Supports multiple processing configurations applied to the same document.
repeated .ai.pipestream.data.v1.SemanticProcessingResult semantic_results = 18 [json_name = "semanticResults"];- Specified by:
getSemanticResultsCountin interfaceSearchMetadataOrBuilder
-
getSemanticResults
Results from semantic chunking and embedding processes. Supports multiple processing configurations applied to the same document.
repeated .ai.pipestream.data.v1.SemanticProcessingResult semantic_results = 18 [json_name = "semanticResults"];- Specified by:
getSemanticResultsin interfaceSearchMetadataOrBuilder
-
getSemanticResultsOrBuilder
Results from semantic chunking and embedding processes. Supports multiple processing configurations applied to the same document.
repeated .ai.pipestream.data.v1.SemanticProcessingResult semantic_results = 18 [json_name = "semanticResults"];- Specified by:
getSemanticResultsOrBuilderin interfaceSearchMetadataOrBuilder
-
hasDoi
public boolean hasDoi()Digital Object Identifier for academic papers and publications.
optional string doi = 19 [json_name = "doi"];- Specified by:
hasDoiin interfaceSearchMetadataOrBuilder- Returns:
- Whether the doi field is set.
-
getDoi
Digital Object Identifier for academic papers and publications.
optional string doi = 19 [json_name = "doi"];- Specified by:
getDoiin interfaceSearchMetadataOrBuilder- Returns:
- The doi.
-
getDoiBytes
public com.google.protobuf.ByteString getDoiBytes()Digital Object Identifier for academic papers and publications.
optional string doi = 19 [json_name = "doi"];- Specified by:
getDoiBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for doi.
-
hasDocOutline
public boolean hasDocOutline()Neutral document outline for navigation and chunking. Supports EPUB TOC, HTML headings, Markdown headings, LaTeX sections, PDF outlines, etc.
optional .ai.pipestream.data.v1.DocOutline doc_outline = 20 [json_name = "docOutline"];- Specified by:
hasDocOutlinein interfaceSearchMetadataOrBuilder- Returns:
- Whether the docOutline field is set.
-
getDocOutline
Neutral document outline for navigation and chunking. Supports EPUB TOC, HTML headings, Markdown headings, LaTeX sections, PDF outlines, etc.
optional .ai.pipestream.data.v1.DocOutline doc_outline = 20 [json_name = "docOutline"];- Specified by:
getDocOutlinein interfaceSearchMetadataOrBuilder- Returns:
- The docOutline.
-
getDocOutlineOrBuilder
Neutral document outline for navigation and chunking. Supports EPUB TOC, HTML headings, Markdown headings, LaTeX sections, PDF outlines, etc.
optional .ai.pipestream.data.v1.DocOutline doc_outline = 20 [json_name = "docOutline"];- Specified by:
getDocOutlineOrBuilderin interfaceSearchMetadataOrBuilder
-
getDiscoveredLinksList
Links discovered within the document. Useful for analyzing document relationships and external references.
repeated .ai.pipestream.data.v1.LinkReference discovered_links = 21 [json_name = "discoveredLinks"];- Specified by:
getDiscoveredLinksListin interfaceSearchMetadataOrBuilder
-
getDiscoveredLinksOrBuilderList
Links discovered within the document. Useful for analyzing document relationships and external references.
repeated .ai.pipestream.data.v1.LinkReference discovered_links = 21 [json_name = "discoveredLinks"];- Specified by:
getDiscoveredLinksOrBuilderListin interfaceSearchMetadataOrBuilder
-
getDiscoveredLinksCount
public int getDiscoveredLinksCount()Links discovered within the document. Useful for analyzing document relationships and external references.
repeated .ai.pipestream.data.v1.LinkReference discovered_links = 21 [json_name = "discoveredLinks"];- Specified by:
getDiscoveredLinksCountin interfaceSearchMetadataOrBuilder
-
getDiscoveredLinks
Links discovered within the document. Useful for analyzing document relationships and external references.
repeated .ai.pipestream.data.v1.LinkReference discovered_links = 21 [json_name = "discoveredLinks"];- Specified by:
getDiscoveredLinksin interfaceSearchMetadataOrBuilder
-
getDiscoveredLinksOrBuilder
Links discovered within the document. Useful for analyzing document relationships and external references.
repeated .ai.pipestream.data.v1.LinkReference discovered_links = 21 [json_name = "discoveredLinks"];- Specified by:
getDiscoveredLinksOrBuilderin interfaceSearchMetadataOrBuilder
-
hasSourcePath
public boolean hasSourcePath()Path portion of source_uri for categorization. Example: "/docs/legal/NY/file.pdf" from "https://example.com/docs/legal/NY/file.pdf"
optional string source_path = 22 [json_name = "sourcePath"];- Specified by:
hasSourcePathin interfaceSearchMetadataOrBuilder- Returns:
- Whether the sourcePath field is set.
-
getSourcePath
Path portion of source_uri for categorization. Example: "/docs/legal/NY/file.pdf" from "https://example.com/docs/legal/NY/file.pdf"
optional string source_path = 22 [json_name = "sourcePath"];- Specified by:
getSourcePathin interfaceSearchMetadataOrBuilder- Returns:
- The sourcePath.
-
getSourcePathBytes
public com.google.protobuf.ByteString getSourcePathBytes()Path portion of source_uri for categorization. Example: "/docs/legal/NY/file.pdf" from "https://example.com/docs/legal/NY/file.pdf"
optional string source_path = 22 [json_name = "sourcePath"];- Specified by:
getSourcePathBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for sourcePath.
-
getSourcePathSegmentsList
public com.google.protobuf.ProtocolStringList getSourcePathSegmentsList()Split path segments from source_path. Example: ["docs", "legal", "NY", "file.pdf"]
repeated string source_path_segments = 23 [json_name = "sourcePathSegments"];- Specified by:
getSourcePathSegmentsListin interfaceSearchMetadataOrBuilder- Returns:
- A list containing the sourcePathSegments.
-
getSourcePathSegmentsCount
public int getSourcePathSegmentsCount()Split path segments from source_path. Example: ["docs", "legal", "NY", "file.pdf"]
repeated string source_path_segments = 23 [json_name = "sourcePathSegments"];- Specified by:
getSourcePathSegmentsCountin interfaceSearchMetadataOrBuilder- Returns:
- The count of sourcePathSegments.
-
getSourcePathSegments
Split path segments from source_path. Example: ["docs", "legal", "NY", "file.pdf"]
repeated string source_path_segments = 23 [json_name = "sourcePathSegments"];- Specified by:
getSourcePathSegmentsin interfaceSearchMetadataOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The sourcePathSegments at the given index.
-
getSourcePathSegmentsBytes
public com.google.protobuf.ByteString getSourcePathSegmentsBytes(int index) Split path segments from source_path. Example: ["docs", "legal", "NY", "file.pdf"]
repeated string source_path_segments = 23 [json_name = "sourcePathSegments"];- Specified by:
getSourcePathSegmentsBytesin interfaceSearchMetadataOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sourcePathSegments at the given index.
-
hasSourceSlug
public boolean hasSourceSlug()Last segment of source_path. Example: "file.pdf" from "/docs/legal/NY/file.pdf"
optional string source_slug = 24 [json_name = "sourceSlug"];- Specified by:
hasSourceSlugin interfaceSearchMetadataOrBuilder- Returns:
- Whether the sourceSlug field is set.
-
getSourceSlug
Last segment of source_path. Example: "file.pdf" from "/docs/legal/NY/file.pdf"
optional string source_slug = 24 [json_name = "sourceSlug"];- Specified by:
getSourceSlugin interfaceSearchMetadataOrBuilder- Returns:
- The sourceSlug.
-
getSourceSlugBytes
public com.google.protobuf.ByteString getSourceSlugBytes()Last segment of source_path. Example: "file.pdf" from "/docs/legal/NY/file.pdf"
optional string source_slug = 24 [json_name = "sourceSlug"];- Specified by:
getSourceSlugBytesin interfaceSearchMetadataOrBuilder- Returns:
- The bytes for sourceSlug.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SearchMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static SearchMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static SearchMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static SearchMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SearchMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SearchMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-