GoogleCloudContentwarehouseV1SearchDocumentsResponse

GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse

Table of Contents ▼

Jump to a specific part of the page:

Response message for DocumentService.SearchDocuments.

This module has the following attributes (case-insensitive ascending order):

View Attributes

histogramQueryResults (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1HistogramQueryResult), default: nil)
- The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.
matchingDocuments (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument), default: nil)
- The document entities that match the specified SearchDocumentsRequest.
metadata (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ResponseMetadata, default: nil)
- Additional information for the API invocation, such as the request tracking id.
nextPageToken (type: String.t, default: nil)
- The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
questionAnswer (type: String.t, default: nil)
- Experimental. Question answer from the query against the document.
totalSize (type: integer(), default: nil)
- 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".

@spec decode(struct(), keyword()) :: struct()