View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponse (google_api_discovery_engine v0.27.0)

Response message for SearchService.Search method.

Attributes

  • 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.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseFacet.t), default: nil) - Results of facets requested by user.
  • 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.
  • queryExpansionInfo (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo.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.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.t), default: nil) - A list of matched documents. The order represents the ranking.
  • searchLinkPromotions (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchLinkPromotion.t), default: nil) - Promotions for site search.
  • sessionInfo (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSessionInfo.t, default: nil) - Session information. Only set if SearchRequest.session is provided. See its description for more details.
  • summary (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummary.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

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponse{
    attributionToken: String.t() | nil,
    correctedQuery: String.t() | nil,
    facets:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseFacet.t()
      ]
      | nil,
    nextPageToken: String.t() | nil,
    queryExpansionInfo:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo.t()
      | nil,
    redirectUri: String.t() | nil,
    results:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.t()
      ]
      | nil,
    searchLinkPromotions:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchLinkPromotion.t()
      ]
      | nil,
    sessionInfo:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSessionInfo.t()
      | nil,
    summary:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummary.t()
      | nil,
    totalSize: integer() | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.