View Source GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse (google_api_content_warehouse v0.4.0)
Response message for DocumentService.SearchDocuments.
Attributes
-
histogramQueryResults
(type:list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1HistogramQueryResult.t)
, default:nil
) - The histogram results that match with the specified SearchDocumentsRequest.histogram_queries. -
matchingDocuments
(type:list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.t)
, default:nil
) - The document entities that match the specified SearchDocumentsRequest. -
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ResponseMetadata.t
, 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 totrue
or set SearchDocumentsRequest.total_result_size toESTIMATED_SIZE
orACTUAL_SIZE
. Otherwise, the value will be-1
. Typically a UI would handle this condition by displaying "of many", for example: "Displaying 10 of many".
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse{ histogramQueryResults: [ GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1HistogramQueryResult.t() ] | nil, matchingDocuments: [ GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.t() ] | nil, metadata: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ResponseMetadata.t() | nil, nextPageToken: String.t() | nil, questionAnswer: String.t() | nil, totalSize: integer() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.