View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponse (google_api_discovery_engine v0.27.0)
Response message for SearchService.Search method.
Attributes
-
appliedControls
(type:list(String.t)
, default:nil
) - Controls applied as part of the Control service. -
attributionToken
(type:String.t
, default:nil
) - A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. -
correctedQuery
(type:String.t
, default:nil
) - Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. -
facets
(type:list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseFacet.t)
, default:nil
) - Results of facets requested by user. -
geoSearchDebugInfo
(type:list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.t)
, default:nil
) - -
guidedSearchResult
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult.t
, default:nil
) - Guided search result. -
naturalLanguageQueryUnderstandingInfo
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.t
, default:nil
) - Natural language query understanding information for the returned results. -
nextPageToken
(type:String.t
, default:nil
) - A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. -
oneBoxResults
(type:list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult.t)
, default:nil
) - A list of One Box results. There can be multiple One Box results of different types. -
queryExpansionInfo
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo.t
, default:nil
) - Query expansion information for the returned results. -
redirectUri
(type:String.t
, default:nil
) - The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. -
results
(type:list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult.t)
, default:nil
) - A list of matched documents. The order represents the ranking. -
searchLinkPromotions
(type:list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.t)
, default:nil
) - Promotions for site search. -
sessionInfo
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo.t
, default:nil
) - Session information. Only set if SearchRequest.session is provided. See its description for more details. -
summary
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSummary.t
, default:nil
) - A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. -
totalSize
(type:integer()
, default:nil
) - The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponse{ appliedControls: [String.t()] | nil, attributionToken: String.t() | nil, correctedQuery: String.t() | nil, facets: [ GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseFacet.t() ] | nil, geoSearchDebugInfo: [ GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.t() ] | nil, guidedSearchResult: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult.t() | nil, naturalLanguageQueryUnderstandingInfo: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.t() | nil, nextPageToken: String.t() | nil, oneBoxResults: [ GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult.t() ] | nil, queryExpansionInfo: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo.t() | nil, redirectUri: String.t() | nil, results: [ GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult.t() ] | nil, searchLinkPromotions: [ GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.t() ] | nil, sessionInfo: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo.t() | nil, summary: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchResponseSummary.t() | nil, totalSize: integer() | nil }