SearchDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for DocumentService.SearchDocuments.
Attributes | |
|---|---|
| Name | Description |
parent |
str
Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}. |
request_metadata |
google.cloud.contentwarehouse_v1.types.RequestMetadata
The meta information collected about the end user, used to enforce access control and improve the search quality of the service. |
document_query |
google.cloud.contentwarehouse_v1.types.DocumentQuery
Query used to search against documents (keyword, filters, etc.). |
offset |
int
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 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). |
page_size |
int
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. |
page_token |
str
The token specifying the current offset within search results. See SearchDocumentsResponse.next_page_token for an explanation of how to obtain the next set of query results. |
order_by |
str
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.
|
histogram_queries |
MutableSequence[google.cloud.contentwarehouse_v1.types.HistogramQuery]
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 |
require_total_size |
bool
Controls if the search document request requires the return of a total size of matched documents. See 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. |
total_result_size |
google.cloud.contentwarehouse_v1.types.SearchDocumentsRequest.TotalResultSize
Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size. |
qa_size_limit |
int
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. |
Classes
TotalResultSize
TotalResultSize(value)The total number of matching documents.
Values: TOTAL_RESULT_SIZE_UNSPECIFIED (0): Total number calculation will be skipped. ESTIMATED_SIZE (1): Estimate total number. The total result size will be accurated up to 10,000. This option will add cost and latency to your request. ACTUAL_SIZE (2): It may adversely impact performance. The limit is 1000,000.