Package com.google.cloud.contentwarehouse.v1

Interface SearchDocumentsResponse.MatchingDocumentOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Document getDocument()
      Document that matches the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
      DocumentOrBuilder getDocumentOrBuilder()
      Document that matches the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
      QAResult getQaResult()
      Experimental.
      QAResultOrBuilder getQaResultOrBuilder()
      Experimental.
      String getSearchTextSnippet()
      Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available.
      com.google.protobuf.ByteString getSearchTextSnippetBytes()
      Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available.
      boolean hasDocument()
      Document that matches the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
      boolean hasQaResult()
      Experimental.

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

      • hasDocument

        boolean hasDocument()
         Document that matches the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
 This document only contains indexed metadata information.
        .google.cloud.contentwarehouse.v1.Document document = 1;
        Returns:
        Whether the document field is set.

      • getDocument

        Document getDocument()
         Document that matches the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
 This document only contains indexed metadata information.
        .google.cloud.contentwarehouse.v1.Document document = 1;
        Returns:
        The document.

      • getDocumentOrBuilder

        DocumentOrBuilder getDocumentOrBuilder()
         Document that matches the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
 This document only contains indexed metadata information.
        .google.cloud.contentwarehouse.v1.Document document = 1;

      • getSearchTextSnippet

        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][google.cloud.contentwarehouse.v1.QAResult.highlights].
        string search_text_snippet = 2;
        Returns:
        The searchTextSnippet.

      • getSearchTextSnippetBytes

        com.google.protobuf.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][google.cloud.contentwarehouse.v1.QAResult.highlights].
        string search_text_snippet = 2;
        Returns:
        The bytes for searchTextSnippet.

      • hasQaResult

        boolean hasQaResult()
         Experimental.
 Additional result info if the question-answering feature is enabled.
        .google.cloud.contentwarehouse.v1.QAResult qa_result = 3;
        Returns:
        Whether the qaResult field is set.

      • getQaResult

        QAResult getQaResult()
         Experimental.
 Additional result info if the question-answering feature is enabled.
        .google.cloud.contentwarehouse.v1.QAResult qa_result = 3;
        Returns:
        The qaResult.

      • getQaResultOrBuilder

        QAResultOrBuilder getQaResultOrBuilder()
         Experimental.
 Additional result info if the question-answering feature is enabled.
        .google.cloud.contentwarehouse.v1.QAResult qa_result = 3;