Interface SearchDocumentsResponse.MatchingDocumentOrBuilder (0.37.0)

Version latest

• 0.37.0 (latest)
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchDocumentsResponse.MatchingDocumentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocument()

public abstract Document getDocument()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type	Description
Document	The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type	Description
DocumentOrBuilder

getMatchedTokenPageIndices(int index)

public abstract long getMatchedTokenPageIndices(int index)

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
long	The matchedTokenPageIndices at the given index.

getMatchedTokenPageIndicesCount()

public abstract int getMatchedTokenPageIndicesCount()

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Returns
Type	Description
int	The count of matchedTokenPageIndices.

getMatchedTokenPageIndicesList()

public abstract List<Long> getMatchedTokenPageIndicesList()

Return the 1-based page indices where those pages have one or more matched tokens.

repeated int64 matched_token_page_indices = 4;

Returns
Type	Description
List<Long>	A list containing the matchedTokenPageIndices.

getQaResult()

public abstract QAResult getQaResult()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type	Description
QAResult	The qaResult.

getQaResultOrBuilder()

public abstract QAResultOrBuilder getQaResultOrBuilder()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type	Description
QAResultOrBuilder

getSearchTextSnippet()

public abstract String getSearchTextSnippet()

Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.

string search_text_snippet = 2;

Returns
Type	Description
String	The searchTextSnippet.

getSearchTextSnippetBytes()

public abstract ByteString getSearchTextSnippetBytes()

Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.

string search_text_snippet = 2;

Returns
Type	Description
ByteString	The bytes for searchTextSnippet.

hasDocument()

public abstract boolean hasDocument()

Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.

.google.cloud.contentwarehouse.v1.Document document = 1;

Returns
Type	Description
boolean	Whether the document field is set.

hasQaResult()

public abstract boolean hasQaResult()

Experimental. Additional result info if the question-answering feature is enabled.

.google.cloud.contentwarehouse.v1.QAResult qa_result = 3;

Returns
Type	Description
boolean	Whether the qaResult field is set.