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