Class protos.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec (1.9.0)

Represents an AnswerGenerationSpec.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.IAnswerGenerationSpec);

Constructs a new AnswerGenerationSpec.

Parameter
Name Description
properties IAnswerGenerationSpec

Properties to set

Properties

_ignoreLowRelevantContent

public _ignoreLowRelevantContent?: "ignoreLowRelevantContent";

AnswerGenerationSpec _ignoreLowRelevantContent.

answerLanguageCode

public answerLanguageCode: string;

AnswerGenerationSpec answerLanguageCode.

ignoreAdversarialQuery

public ignoreAdversarialQuery: boolean;

AnswerGenerationSpec ignoreAdversarialQuery.

ignoreLowRelevantContent

public ignoreLowRelevantContent?: (boolean|null);

AnswerGenerationSpec ignoreLowRelevantContent.

ignoreNonAnswerSeekingQuery

public ignoreNonAnswerSeekingQuery: boolean;

AnswerGenerationSpec ignoreNonAnswerSeekingQuery.

includeCitations

public includeCitations: boolean;

AnswerGenerationSpec includeCitations.

modelSpec

public modelSpec?: (google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.IModelSpec|null);

AnswerGenerationSpec modelSpec.

promptSpec

public promptSpec?: (google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.IPromptSpec|null);

AnswerGenerationSpec promptSpec.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.IAnswerGenerationSpec): google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec;

Creates a new AnswerGenerationSpec instance using the specified properties.

Parameter
Name Description
properties IAnswerGenerationSpec

Properties to set

Returns
Type Description
AnswerGenerationSpec

AnswerGenerationSpec instance

decode(reader, length)

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

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

AnswerGenerationSpec

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AnswerGenerationSpec

AnswerGenerationSpec

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.IAnswerGenerationSpec, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AnswerGenerationSpec message. Does not implicitly messages.

Parameters
Name Description
message IAnswerGenerationSpec

AnswerGenerationSpec 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.v1alpha.AnswerQueryRequest.IAnswerGenerationSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAnswerGenerationSpec

AnswerGenerationSpec 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.v1alpha.AnswerQueryRequest.AnswerGenerationSpec;

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

AnswerGenerationSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AnswerGenerationSpec

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AnswerGenerationSpec

AnswerGenerationSpec

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 AnswerGenerationSpec 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