Represents a GenerationConfig.
Package
@google-ai/generativelanguageConstructors
(constructor)(properties)
constructor(properties?: google.ai.generativelanguage.v1beta.IGenerationConfig);
Constructs a new GenerationConfig.
Parameter | |
---|---|
Name | Description |
properties |
IGenerationConfig
Properties to set |
Properties
_candidateCount
public _candidateCount?: "candidateCount";
GenerationConfig _candidateCount.
_maxOutputTokens
public _maxOutputTokens?: "maxOutputTokens";
GenerationConfig _maxOutputTokens.
_temperature
public _temperature?: "temperature";
GenerationConfig _temperature.
_topK
public _topK?: "topK";
GenerationConfig _topK.
_topP
public _topP?: "topP";
GenerationConfig _topP.
candidateCount
public candidateCount?: (number|null);
GenerationConfig candidateCount.
maxOutputTokens
public maxOutputTokens?: (number|null);
GenerationConfig maxOutputTokens.
responseMimeType
public responseMimeType: string;
GenerationConfig responseMimeType.
responseSchema
public responseSchema?: (google.ai.generativelanguage.v1beta.ISchema|null);
GenerationConfig responseSchema.
stopSequences
public stopSequences: string[];
GenerationConfig stopSequences.
temperature
public temperature?: (number|null);
GenerationConfig temperature.
topK
public topK?: (number|null);
GenerationConfig topK.
topP
public topP?: (number|null);
GenerationConfig topP.
Methods
create(properties)
public static create(properties?: google.ai.generativelanguage.v1beta.IGenerationConfig): google.ai.generativelanguage.v1beta.GenerationConfig;
Creates a new GenerationConfig instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IGenerationConfig
Properties to set |
Returns | |
---|---|
Type | Description |
GenerationConfig |
GenerationConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.GenerationConfig;
Decodes a GenerationConfig 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 |
GenerationConfig |
GenerationConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.GenerationConfig;
Decodes a GenerationConfig message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
GenerationConfig |
GenerationConfig |
encode(message, writer)
public static encode(message: google.ai.generativelanguage.v1beta.IGenerationConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified GenerationConfig message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IGenerationConfig
GenerationConfig 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.IGenerationConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified GenerationConfig message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IGenerationConfig
GenerationConfig 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.GenerationConfig;
Creates a GenerationConfig 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 |
GenerationConfig |
GenerationConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for GenerationConfig
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 GenerationConfig to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ai.generativelanguage.v1beta.GenerationConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a GenerationConfig message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
GenerationConfig
GenerationConfig |
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 GenerationConfig message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|