Represents a ConversationalSearchResponse.
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.cloud.retail.v2beta.IConversationalSearchResponse);Constructs a new ConversationalSearchResponse.
| Parameter | |
|---|---|
| Name | Description |
properties |
IConversationalSearchResponse
Properties to set |
Properties
conversationalFilteringResult
public conversationalFilteringResult?: (google.cloud.retail.v2beta.ConversationalSearchResponse.IConversationalFilteringResult|null);ConversationalSearchResponse conversationalFilteringResult.
conversationalTextResponse
public conversationalTextResponse: string;ConversationalSearchResponse conversationalTextResponse.
conversationId
public conversationId: string;ConversationalSearchResponse conversationId.
followupQuestion
public followupQuestion?: (google.cloud.retail.v2beta.ConversationalSearchResponse.IFollowupQuestion|null);ConversationalSearchResponse followupQuestion.
refinedSearch
public refinedSearch: google.cloud.retail.v2beta.ConversationalSearchResponse.IRefinedSearch[];ConversationalSearchResponse refinedSearch.
state
public state: (google.cloud.retail.v2beta.ConversationalSearchResponse.State|keyof typeof google.cloud.retail.v2beta.ConversationalSearchResponse.State);ConversationalSearchResponse state.
userQueryTypes
public userQueryTypes: string[];ConversationalSearchResponse userQueryTypes.
Methods
create(properties)
public static create(properties?: google.cloud.retail.v2beta.IConversationalSearchResponse): google.cloud.retail.v2beta.ConversationalSearchResponse;Creates a new ConversationalSearchResponse instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IConversationalSearchResponse
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
ConversationalSearchResponse instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2beta.ConversationalSearchResponse;Decodes a ConversationalSearchResponse message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
ConversationalSearchResponse |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2beta.ConversationalSearchResponse;Decodes a ConversationalSearchResponse message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
ConversationalSearchResponse |
encode(message, writer)
public static encode(message: google.cloud.retail.v2beta.IConversationalSearchResponse, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ConversationalSearchResponse message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IConversationalSearchResponse
ConversationalSearchResponse message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.retail.v2beta.IConversationalSearchResponse, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ConversationalSearchResponse message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IConversationalSearchResponse
ConversationalSearchResponse message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2beta.ConversationalSearchResponse;Creates a ConversationalSearchResponse message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
ConversationalSearchResponse |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ConversationalSearchResponse
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ConversationalSearchResponse to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.retail.v2beta.ConversationalSearchResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ConversationalSearchResponse message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ConversationalSearchResponse
ConversationalSearchResponse |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ConversationalSearchResponse message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|