Class GoogleCloudDiscoveryengineV1alphaSearchResponse

Response message for SearchService.Search method.

Inheritance

object

GoogleCloudDiscoveryengineV1alphaSearchResponse

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class GoogleCloudDiscoveryengineV1alphaSearchResponse : IDirectResponseSchema

Properties

AppliedControls

Controls applied as part of the Control service.

Declaration

[JsonProperty("appliedControls")]
public virtual IList<string> AppliedControls { get; set; }

Property Value

Type	Description
IList<string>

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<GoogleCloudDiscoveryengineV1alphaSearchResponseFacet> Facets { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaSearchResponseFacet>

GeoSearchDebugInfo

Declaration

[JsonProperty("geoSearchDebugInfo")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo> GeoSearchDebugInfo { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo>

GuidedSearchResult

Guided search result.

Declaration

[JsonProperty("guidedSearchResult")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult GuidedSearchResult { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult

NaturalLanguageQueryUnderstandingInfo

Natural language query understanding information for the returned results.

Declaration

[JsonProperty("naturalLanguageQueryUnderstandingInfo")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo NaturalLanguageQueryUnderstandingInfo { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo

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

OneBoxResults

A list of One Box results. There can be multiple One Box results of different types.

Declaration

[JsonProperty("oneBoxResults")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult> OneBoxResults { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult>

QueryExpansionInfo

Query expansion information for the returned results.

Declaration

[JsonProperty("queryExpansionInfo")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo QueryExpansionInfo { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

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<GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult> Results { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult>

SessionInfo

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

Declaration

[JsonProperty("sessionInfo")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo SessionInfo { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo

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 GoogleCloudDiscoveryengineV1alphaSearchResponseSummary Summary { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchResponseSummary

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

IDirectResponseSchema