Class protos.google.ai.generativelanguage.v1beta.GenerateAnswerRequest (2.3.0)

Represents a GenerateAnswerRequest.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1beta.IGenerateAnswerRequest);

Constructs a new GenerateAnswerRequest.

Parameter
Name Description
properties IGenerateAnswerRequest

Properties to set

Properties

_temperature

public _temperature?: "temperature";

GenerateAnswerRequest _temperature.

answerStyle

public answerStyle: (google.ai.generativelanguage.v1beta.GenerateAnswerRequest.AnswerStyle|keyof typeof google.ai.generativelanguage.v1beta.GenerateAnswerRequest.AnswerStyle);

GenerateAnswerRequest answerStyle.

contents

public contents: google.ai.generativelanguage.v1beta.IContent[];

GenerateAnswerRequest contents.

groundingSource

public groundingSource?: ("inlinePassages"|"semanticRetriever");

GenerateAnswerRequest groundingSource.

inlinePassages

public inlinePassages?: (google.ai.generativelanguage.v1beta.IGroundingPassages|null);

GenerateAnswerRequest inlinePassages.

model

public model: string;

GenerateAnswerRequest model.

safetySettings

public safetySettings: google.ai.generativelanguage.v1beta.ISafetySetting[];

GenerateAnswerRequest safetySettings.

semanticRetriever

public semanticRetriever?: (google.ai.generativelanguage.v1beta.ISemanticRetrieverConfig|null);

GenerateAnswerRequest semanticRetriever.

temperature

public temperature?: (number|null);

GenerateAnswerRequest temperature.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.IGenerateAnswerRequest): google.ai.generativelanguage.v1beta.GenerateAnswerRequest;

Creates a new GenerateAnswerRequest instance using the specified properties.

Parameter
Name Description
properties IGenerateAnswerRequest

Properties to set

Returns
Type Description
GenerateAnswerRequest

GenerateAnswerRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.GenerateAnswerRequest;

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

GenerateAnswerRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.GenerateAnswerRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GenerateAnswerRequest

GenerateAnswerRequest

encode(message, writer)

public static encode(message: google.ai.generativelanguage.v1beta.IGenerateAnswerRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerateAnswerRequest message. Does not implicitly messages.

Parameters
Name Description
message IGenerateAnswerRequest

GenerateAnswerRequest 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.ai.generativelanguage.v1beta.IGenerateAnswerRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGenerateAnswerRequest

GenerateAnswerRequest 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.ai.generativelanguage.v1beta.GenerateAnswerRequest;

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

GenerateAnswerRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GenerateAnswerRequest

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

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

JSON object

toObject(message, options)

public static toObject(message: google.ai.generativelanguage.v1beta.GenerateAnswerRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message GenerateAnswerRequest

GenerateAnswerRequest

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