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