Class GoogleCloudDiscoveryengineV1SearchResponse

Response message for SearchService.Search method.

Inheritance
object
GoogleCloudDiscoveryengineV1SearchResponse
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1.Data
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class GoogleCloudDiscoveryengineV1SearchResponse : IDirectResponseSchema

Properties

AttributionToken

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.

Declaration
[JsonProperty("attributionToken")]
public virtual string AttributionToken { get; set; }
Property Value
Type Description
string

CorrectedQuery

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.

Declaration
[JsonProperty("correctedQuery")]
public virtual string CorrectedQuery { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Facets

Results of facets requested by user.

Declaration
[JsonProperty("facets")]
public virtual IList<GoogleCloudDiscoveryengineV1SearchResponseFacet> Facets { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1SearchResponseFacet>

NextPageToken

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.

Declaration
[JsonProperty("nextPageToken")]
public virtual string NextPageToken { get; set; }
Property Value
Type Description
string

QueryExpansionInfo

Query expansion information for the returned results.

Declaration
[JsonProperty("queryExpansionInfo")]
public virtual GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo QueryExpansionInfo { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo

RedirectUri

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.

Declaration
[JsonProperty("redirectUri")]
public virtual string RedirectUri { get; set; }
Property Value
Type Description
string

Results

A list of matched documents. The order represents the ranking.

Declaration
[JsonProperty("results")]
public virtual IList<GoogleCloudDiscoveryengineV1SearchResponseSearchResult> Results { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1SearchResponseSearchResult>

SessionInfo

Session information. Only set if SearchRequest.session is provided. See its description for more details.

Declaration
[JsonProperty("sessionInfo")]
public virtual GoogleCloudDiscoveryengineV1SearchResponseSessionInfo SessionInfo { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1SearchResponseSessionInfo

Summary

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

Declaration
[JsonProperty("summary")]
public virtual GoogleCloudDiscoveryengineV1SearchResponseSummary Summary { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1SearchResponseSummary

TotalSize

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.

Declaration
[JsonProperty("totalSize")]
public virtual int? TotalSize { get; set; }
Property Value
Type Description
int?

Implements