Represents a TunedModel.
Package
@google-ai/generativelanguageConstructors
(constructor)(properties)
constructor(properties?: google.ai.generativelanguage.v1alpha.ITunedModel);Constructs a new TunedModel.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITunedModel
Properties to set |
Properties
_temperature
public _temperature?: "temperature";TunedModel _temperature.
_topK
public _topK?: "topK";TunedModel _topK.
_topP
public _topP?: "topP";TunedModel _topP.
baseModel
public baseModel?: (string|null);TunedModel baseModel.
createTime
public createTime?: (google.protobuf.ITimestamp|null);TunedModel createTime.
description
public description: string;TunedModel description.
displayName
public displayName: string;TunedModel displayName.
name
public name: string;TunedModel name.
readerProjectNumbers
public readerProjectNumbers: (number|Long|string)[];TunedModel readerProjectNumbers.
sourceModel
public sourceModel?: ("tunedModelSource"|"baseModel");TunedModel sourceModel.
state
public state: (google.ai.generativelanguage.v1alpha.TunedModel.State|keyof typeof google.ai.generativelanguage.v1alpha.TunedModel.State);TunedModel state.
temperature
public temperature?: (number|null);TunedModel temperature.
topK
public topK?: (number|null);TunedModel topK.
topP
public topP?: (number|null);TunedModel topP.
tunedModelSource
public tunedModelSource?: (google.ai.generativelanguage.v1alpha.ITunedModelSource|null);TunedModel tunedModelSource.
tuningTask
public tuningTask?: (google.ai.generativelanguage.v1alpha.ITuningTask|null);TunedModel tuningTask.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);TunedModel updateTime.
Methods
create(properties)
public static create(properties?: google.ai.generativelanguage.v1alpha.ITunedModel): google.ai.generativelanguage.v1alpha.TunedModel;Creates a new TunedModel instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITunedModel
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TunedModel |
TunedModel instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1alpha.TunedModel;Decodes a TunedModel 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 |
TunedModel |
TunedModel |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1alpha.TunedModel;Decodes a TunedModel message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TunedModel |
TunedModel |
encode(message, writer)
public static encode(message: google.ai.generativelanguage.v1alpha.ITunedModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TunedModel message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITunedModel
TunedModel 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.v1alpha.ITunedModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TunedModel message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITunedModel
TunedModel 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.v1alpha.TunedModel;Creates a TunedModel 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 |
TunedModel |
TunedModel |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TunedModel
| 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 TunedModel to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ai.generativelanguage.v1alpha.TunedModel, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TunedModel message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TunedModel
TunedModel |
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 TunedModel message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|