Class protos.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult (3.6.0)

Represents a ConversationalSearchResult.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2alpha.SearchResponse.IConversationalSearchResult);

Constructs a new ConversationalSearchResult.

Parameter
Name Description
properties IConversationalSearchResult

Properties to set

Properties

additionalFilter

public additionalFilter?: (google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.IAdditionalFilter|null);

ConversationalSearchResult additionalFilter.

additionalFilters

public additionalFilters: google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.IAdditionalFilter[];

ConversationalSearchResult additionalFilters.

conversationId

public conversationId: string;

ConversationalSearchResult conversationId.

followupQuestion

public followupQuestion: string;

ConversationalSearchResult followupQuestion.

refinedQuery

public refinedQuery: string;

ConversationalSearchResult refinedQuery.

suggestedAnswers

public suggestedAnswers: google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.ISuggestedAnswer[];

ConversationalSearchResult suggestedAnswers.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.SearchResponse.IConversationalSearchResult): google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult;

Creates a new ConversationalSearchResult instance using the specified properties.

Parameter
Name Description
properties IConversationalSearchResult

Properties to set

Returns
Type Description
ConversationalSearchResult

ConversationalSearchResult instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult;

Decodes a ConversationalSearchResult 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
ConversationalSearchResult

ConversationalSearchResult

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult;

Decodes a ConversationalSearchResult message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ConversationalSearchResult

ConversationalSearchResult

encode(message, writer)

public static encode(message: google.cloud.retail.v2alpha.SearchResponse.IConversationalSearchResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ConversationalSearchResult message. Does not implicitly messages.

Parameters
Name Description
message IConversationalSearchResult

ConversationalSearchResult 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.v2alpha.SearchResponse.IConversationalSearchResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ConversationalSearchResult message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IConversationalSearchResult

ConversationalSearchResult 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.v2alpha.SearchResponse.ConversationalSearchResult;

Creates a ConversationalSearchResult 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
ConversationalSearchResult

ConversationalSearchResult

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ConversationalSearchResult

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 ConversationalSearchResult to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ConversationalSearchResult message. Also converts values to other types if specified.

Parameters
Name Description
message ConversationalSearchResult

ConversationalSearchResult

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 ConversationalSearchResult message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not