Class protos.google.cloud.discoveryengine.v1.AnswerQueryRequest (1.14.0)

Represents an AnswerQueryRequest.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1.IAnswerQueryRequest);

Constructs a new AnswerQueryRequest.

Parameter
Name Description
properties IAnswerQueryRequest

Properties to set

Properties

answerGenerationSpec

public answerGenerationSpec?: (google.cloud.discoveryengine.v1.AnswerQueryRequest.IAnswerGenerationSpec|null);

AnswerQueryRequest answerGenerationSpec.

asynchronousMode

public asynchronousMode: boolean;

AnswerQueryRequest asynchronousMode.

query

public query?: (google.cloud.discoveryengine.v1.IQuery|null);

AnswerQueryRequest query.

queryUnderstandingSpec

public queryUnderstandingSpec?: (google.cloud.discoveryengine.v1.AnswerQueryRequest.IQueryUnderstandingSpec|null);

AnswerQueryRequest queryUnderstandingSpec.

relatedQuestionsSpec

public relatedQuestionsSpec?: (google.cloud.discoveryengine.v1.AnswerQueryRequest.IRelatedQuestionsSpec|null);

AnswerQueryRequest relatedQuestionsSpec.

safetySpec

public safetySpec?: (google.cloud.discoveryengine.v1.AnswerQueryRequest.ISafetySpec|null);

AnswerQueryRequest safetySpec.

searchSpec

public searchSpec?: (google.cloud.discoveryengine.v1.AnswerQueryRequest.ISearchSpec|null);

AnswerQueryRequest searchSpec.

servingConfig

public servingConfig: string;

AnswerQueryRequest servingConfig.

session

public session: string;

AnswerQueryRequest session.

userLabels

public userLabels: { [k: string]: string };

AnswerQueryRequest userLabels.

userPseudoId

public userPseudoId: string;

AnswerQueryRequest userPseudoId.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1.IAnswerQueryRequest): google.cloud.discoveryengine.v1.AnswerQueryRequest;

Creates a new AnswerQueryRequest instance using the specified properties.

Parameter
Name Description
properties IAnswerQueryRequest

Properties to set

Returns
Type Description
AnswerQueryRequest

AnswerQueryRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.AnswerQueryRequest;

Decodes an AnswerQueryRequest 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
AnswerQueryRequest

AnswerQueryRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.AnswerQueryRequest;

Decodes an AnswerQueryRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AnswerQueryRequest

AnswerQueryRequest

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1.IAnswerQueryRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AnswerQueryRequest message. Does not implicitly messages.

Parameters
Name Description
message IAnswerQueryRequest

AnswerQueryRequest 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.discoveryengine.v1.IAnswerQueryRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAnswerQueryRequest

AnswerQueryRequest 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.discoveryengine.v1.AnswerQueryRequest;

Creates an AnswerQueryRequest 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
AnswerQueryRequest

AnswerQueryRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AnswerQueryRequest

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

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.discoveryengine.v1.AnswerQueryRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message AnswerQueryRequest

AnswerQueryRequest

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 an AnswerQueryRequest 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