Class GoogleCloudRetailV2alphaConversationalSearchRequest

Request message for ConversationalSearchService.ConversationalSearch method.

Inheritance
object
GoogleCloudRetailV2alphaConversationalSearchRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2alpha.Data
Assembly: Google.Apis.CloudRetail.v2alpha.dll
Syntax
public class GoogleCloudRetailV2alphaConversationalSearchRequest : IDirectResponseSchema

Properties

Branch

Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

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

ConversationId

Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.

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

ConversationalFilteringSpec

Optional. This field specifies all conversational filtering related parameters.

Declaration
[JsonProperty("conversationalFilteringSpec")]
public virtual GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec ConversationalFilteringSpec { get; set; }
Property Value
Type Description
GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec

ETag

The ETag of the item.

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

PageCategories

Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

Declaration
[JsonProperty("pageCategories")]
public virtual IList<string> PageCategories { get; set; }
Property Value
Type Description
IList<string>

Query

Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.

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

SearchParams

Optional. Search parameters.

Declaration
[JsonProperty("searchParams")]
public virtual GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams SearchParams { get; set; }
Property Value
Type Description
GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams

UserInfo

Optional. User information.

Declaration
[JsonProperty("userInfo")]
public virtual GoogleCloudRetailV2alphaUserInfo UserInfo { get; set; }
Property Value
Type Description
GoogleCloudRetailV2alphaUserInfo

VisitorId

Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Implements