Package com.google.cloud.contentwarehouse.v1

Interface SearchDocumentsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchDocumentsRequest, SearchDocumentsRequest.Builder
    public interface SearchDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getParent

        String getParent()
         Required. The parent, which owns this collection of documents.
 Format: projects/{project_number}/locations/{location}.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The parent, which owns this collection of documents.
 Format: projects/{project_number}/locations/{location}.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • hasRequestMetadata

        boolean hasRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control and improve the search quality of the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Returns:
        Whether the requestMetadata field is set.

      • getRequestMetadata

        RequestMetadata getRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control and improve the search quality of the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Returns:
        The requestMetadata.

      • getRequestMetadataOrBuilder

        RequestMetadataOrBuilder getRequestMetadataOrBuilder()
         The meta information collected about the end user, used to enforce access
 control and improve the search quality of the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

      • hasDocumentQuery

        boolean hasDocumentQuery()
         Query used to search against documents (keyword, filters, etc.).
        .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
        Returns:
        Whether the documentQuery field is set.

      • getDocumentQuery

        DocumentQuery getDocumentQuery()
         Query used to search against documents (keyword, filters, etc.).
        .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
        Returns:
        The documentQuery.

      • getDocumentQueryOrBuilder

        DocumentQueryOrBuilder getDocumentQueryOrBuilder()
         Query used to search against documents (keyword, filters, etc.).
        .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;

      • getOffset

        int getOffset()
         An integer that specifies the current offset (that is, starting result
 location, amongst the documents deemed by the API as relevant) in search
 results. This field is only considered if
 [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token]
 is unset.

 The maximum allowed value is 5000. Otherwise an error is thrown.

 For example, 0 means to  return results starting from the first matching
 document, and 10 means to return from the 11th document. This can be used
 for pagination, (for example, pageSize = 10 and offset = 10 means to return
 from the second page).
        int32 offset = 5;
        Returns:
        The offset.

      • getPageSize

        int getPageSize()
         A limit on the number of documents returned in the search results.
 Increasing this value above the default value of 10 can increase search
 response time. The value can be between 1 and 100.
        int32 page_size = 6;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         The token specifying the current offset within search results.
 See
 [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token]
 for an explanation of how to obtain the next set of query results.
        string page_token = 7;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The token specifying the current offset within search results.
 See
 [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token]
 for an explanation of how to obtain the next set of query results.
        string page_token = 7;
        Returns:
        The bytes for pageToken.

      • getOrderBy

        String getOrderBy()
         The criteria determining how search results are sorted. For non-empty
 query, default is `"relevance desc"`. For empty query, default is
 `"upload_date desc"`.

 Supported options are:

 * `"relevance desc"`: By relevance descending, as determined by the API
   algorithms.
 * `"upload_date desc"`: By upload date descending.
 * `"upload_date"`: By upload date ascending.
 * `"update_date desc"`: By last updated date descending.
 * `"update_date"`: By last updated date ascending.
 * `"retrieval_importance desc"`: By retrieval importance of properties
   descending. This feature is still under development, please do not use
   unless otherwise instructed to do so.
        string order_by = 8;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         The criteria determining how search results are sorted. For non-empty
 query, default is `"relevance desc"`. For empty query, default is
 `"upload_date desc"`.

 Supported options are:

 * `"relevance desc"`: By relevance descending, as determined by the API
   algorithms.
 * `"upload_date desc"`: By upload date descending.
 * `"upload_date"`: By upload date ascending.
 * `"update_date desc"`: By last updated date descending.
 * `"update_date"`: By last updated date ascending.
 * `"retrieval_importance desc"`: By retrieval importance of properties
   descending. This feature is still under development, please do not use
   unless otherwise instructed to do so.
        string order_by = 8;
        Returns:
        The bytes for orderBy.

      • getHistogramQueriesList

        List<HistogramQuery> getHistogramQueriesList()
         An expression specifying a histogram request against matching
 documents. Expression syntax is an aggregation function call with
 histogram facets and other options.

 The following aggregation functions are supported:

 * `count(string_histogram_facet)`: Count the number of matching entities
 for each distinct attribute value.

 Data types:

 * Histogram facet (aka filterable properties): Facet names with format
 &lt;schema id&gt;.&lt;facet&gt;. Facets will have the
 format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
 facet, then the parent hierarchy needs to be specified separated by
 dots in the prefix after the schema id. Thus, the format for a multi-
 level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. Example:
 schema123.root_parent_facet.middle_facet.child_facet
 * DocumentSchemaId: (with no schema id prefix) to get
 histograms for each document type (returns the schema id path, e.g.
 projects/12345/locations/us-west/documentSchemas/abc123).

 Example expression:

 * Document type counts:
   count('DocumentSchemaId')

 * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   count('abc123.MORTGAGE_TYPE')
        repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

      • getHistogramQueries

        HistogramQuery getHistogramQueries​(int index)
         An expression specifying a histogram request against matching
 documents. Expression syntax is an aggregation function call with
 histogram facets and other options.

 The following aggregation functions are supported:

 * `count(string_histogram_facet)`: Count the number of matching entities
 for each distinct attribute value.

 Data types:

 * Histogram facet (aka filterable properties): Facet names with format
 &lt;schema id&gt;.&lt;facet&gt;. Facets will have the
 format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
 facet, then the parent hierarchy needs to be specified separated by
 dots in the prefix after the schema id. Thus, the format for a multi-
 level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. Example:
 schema123.root_parent_facet.middle_facet.child_facet
 * DocumentSchemaId: (with no schema id prefix) to get
 histograms for each document type (returns the schema id path, e.g.
 projects/12345/locations/us-west/documentSchemas/abc123).

 Example expression:

 * Document type counts:
   count('DocumentSchemaId')

 * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   count('abc123.MORTGAGE_TYPE')
        repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

      • getHistogramQueriesCount

        int getHistogramQueriesCount()
         An expression specifying a histogram request against matching
 documents. Expression syntax is an aggregation function call with
 histogram facets and other options.

 The following aggregation functions are supported:

 * `count(string_histogram_facet)`: Count the number of matching entities
 for each distinct attribute value.

 Data types:

 * Histogram facet (aka filterable properties): Facet names with format
 &lt;schema id&gt;.&lt;facet&gt;. Facets will have the
 format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
 facet, then the parent hierarchy needs to be specified separated by
 dots in the prefix after the schema id. Thus, the format for a multi-
 level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. Example:
 schema123.root_parent_facet.middle_facet.child_facet
 * DocumentSchemaId: (with no schema id prefix) to get
 histograms for each document type (returns the schema id path, e.g.
 projects/12345/locations/us-west/documentSchemas/abc123).

 Example expression:

 * Document type counts:
   count('DocumentSchemaId')

 * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   count('abc123.MORTGAGE_TYPE')
        repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

      • getHistogramQueriesOrBuilderList

        List<? extends HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()
         An expression specifying a histogram request against matching
 documents. Expression syntax is an aggregation function call with
 histogram facets and other options.

 The following aggregation functions are supported:

 * `count(string_histogram_facet)`: Count the number of matching entities
 for each distinct attribute value.

 Data types:

 * Histogram facet (aka filterable properties): Facet names with format
 &lt;schema id&gt;.&lt;facet&gt;. Facets will have the
 format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
 facet, then the parent hierarchy needs to be specified separated by
 dots in the prefix after the schema id. Thus, the format for a multi-
 level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. Example:
 schema123.root_parent_facet.middle_facet.child_facet
 * DocumentSchemaId: (with no schema id prefix) to get
 histograms for each document type (returns the schema id path, e.g.
 projects/12345/locations/us-west/documentSchemas/abc123).

 Example expression:

 * Document type counts:
   count('DocumentSchemaId')

 * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   count('abc123.MORTGAGE_TYPE')
        repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

      • getHistogramQueriesOrBuilder

        HistogramQueryOrBuilder getHistogramQueriesOrBuilder​(int index)
         An expression specifying a histogram request against matching
 documents. Expression syntax is an aggregation function call with
 histogram facets and other options.

 The following aggregation functions are supported:

 * `count(string_histogram_facet)`: Count the number of matching entities
 for each distinct attribute value.

 Data types:

 * Histogram facet (aka filterable properties): Facet names with format
 &lt;schema id&gt;.&lt;facet&gt;. Facets will have the
 format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
 facet, then the parent hierarchy needs to be specified separated by
 dots in the prefix after the schema id. Thus, the format for a multi-
 level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. Example:
 schema123.root_parent_facet.middle_facet.child_facet
 * DocumentSchemaId: (with no schema id prefix) to get
 histograms for each document type (returns the schema id path, e.g.
 projects/12345/locations/us-west/documentSchemas/abc123).

 Example expression:

 * Document type counts:
   count('DocumentSchemaId')

 * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   count('abc123.MORTGAGE_TYPE')
        repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;

      • getRequireTotalSize

        boolean getRequireTotalSize()
         Controls if the search document request requires the return of a total size
 of matched documents. See
 [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].

 Enabling this flag may adversely impact performance. Hint: If this is
 used with pagination, set this flag on the initial query but set this
 to false on subsequent page calls (keep the total count locally).

 Defaults to false.
        bool require_total_size = 10;
        Returns:
        The requireTotalSize.

      • getTotalResultSizeValue

        int getTotalResultSizeValue()
         Controls if the search document request requires the return of a total size
 of matched documents. See
 [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
        .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;
        Returns:
        The enum numeric value on the wire for totalResultSize.

      • getTotalResultSize

        SearchDocumentsRequest.TotalResultSize getTotalResultSize()
         Controls if the search document request requires the return of a total size
 of matched documents. See
 [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
        .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;
        Returns:
        The totalResultSize.

      • getQaSizeLimit

        int getQaSizeLimit()
         Experimental, do not use.
 The limit on the number of documents returned for the question-answering
 feature. To enable the question-answering feature, set
 [DocumentQuery].[is_nl_query][] to true.
        int32 qa_size_limit = 11;
        Returns:
        The qaSizeLimit.