SearchDocumentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)Response message for DocumentService.SearchDocuments.
Attributes | |
|---|---|
| Name | Description |
matching_documents |
MutableSequence[google.cloud.contentwarehouse_v1.types.SearchDocumentsResponse.MatchingDocument]
The document entities that match the specified SearchDocumentsRequest. |
next_page_token |
str
The token that specifies the starting position of the next page of results. This field is empty if there are no more results. |
total_size |
int
The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set
SearchDocumentsRequest.total_result_size
to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the
value will be -1. Typically a UI would handle this
condition by displaying "of many", for example: "Displaying
10 of many".
|
metadata |
google.cloud.contentwarehouse_v1.types.ResponseMetadata
Additional information for the API invocation, such as the request tracking id. |
histogram_query_results |
MutableSequence[google.cloud.contentwarehouse_v1.types.HistogramQueryResult]
The histogram results that match with the specified SearchDocumentsRequest.histogram_queries. |
Classes
MatchingDocument
MatchingDocument(mapping=None, *, ignore_unknown_fields=False, **kwargs)Document entry with metadata inside SearchDocumentsResponse