Class protos.google.ai.generativelanguage.v1beta.Model (2.4.0)

Represents a Model.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

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

Constructs a new Model.

Parameter
Name Description
properties IModel

Properties to set

Properties

_temperature

public _temperature?: "temperature";

Model _temperature.

_topK

public _topK?: "topK";

Model _topK.

_topP

public _topP?: "topP";

Model _topP.

baseModelId

public baseModelId: string;

Model baseModelId.

description

public description: string;

Model description.

displayName

public displayName: string;

Model displayName.

inputTokenLimit

public inputTokenLimit: number;

Model inputTokenLimit.

name

public name: string;

Model name.

outputTokenLimit

public outputTokenLimit: number;

Model outputTokenLimit.

supportedGenerationMethods

public supportedGenerationMethods: string[];

Model supportedGenerationMethods.

temperature

public temperature?: (number|null);

Model temperature.

topK

public topK?: (number|null);

Model topK.

topP

public topP?: (number|null);

Model topP.

version

public version: string;

Model version.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.IModel): google.ai.generativelanguage.v1beta.Model;

Creates a new Model instance using the specified properties.

Parameter
Name Description
properties IModel

Properties to set

Returns
Type Description
Model

Model instance

decode(reader, length)

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

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

Model

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Model

Model

encode(message, writer)

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

Encodes the specified Model message. Does not implicitly messages.

Parameters
Name Description
message IModel

Model 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.IModel, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IModel

Model 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.Model;

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

Model

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Model

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Model

Model

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