Represents a GenerateContentRequest.
Package
@google-ai/generativelanguageConstructors
(constructor)(properties)
constructor(properties?: google.ai.generativelanguage.v1beta.IGenerateContentRequest);Constructs a new GenerateContentRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IGenerateContentRequest
Properties to set |
Properties
_generationConfig
public _generationConfig?: "generationConfig";GenerateContentRequest _generationConfig.
_systemInstruction
public _systemInstruction?: "systemInstruction";GenerateContentRequest _systemInstruction.
contents
public contents: google.ai.generativelanguage.v1beta.IContent[];GenerateContentRequest contents.
generationConfig
public generationConfig?: (google.ai.generativelanguage.v1beta.IGenerationConfig|null);GenerateContentRequest generationConfig.
model
public model: string;GenerateContentRequest model.
safetySettings
public safetySettings: google.ai.generativelanguage.v1beta.ISafetySetting[];GenerateContentRequest safetySettings.
systemInstruction
public systemInstruction?: (google.ai.generativelanguage.v1beta.IContent|null);GenerateContentRequest systemInstruction.
toolConfig
public toolConfig?: (google.ai.generativelanguage.v1beta.IToolConfig|null);GenerateContentRequest toolConfig.
tools
public tools: google.ai.generativelanguage.v1beta.ITool[];GenerateContentRequest tools.
Methods
create(properties)
public static create(properties?: google.ai.generativelanguage.v1beta.IGenerateContentRequest): google.ai.generativelanguage.v1beta.GenerateContentRequest;Creates a new GenerateContentRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IGenerateContentRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
GenerateContentRequest |
GenerateContentRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.GenerateContentRequest;Decodes a GenerateContentRequest 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 |
GenerateContentRequest |
GenerateContentRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.GenerateContentRequest;Decodes a GenerateContentRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
GenerateContentRequest |
GenerateContentRequest |
encode(message, writer)
public static encode(message: google.ai.generativelanguage.v1beta.IGenerateContentRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified GenerateContentRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IGenerateContentRequest
GenerateContentRequest 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.IGenerateContentRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified GenerateContentRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IGenerateContentRequest
GenerateContentRequest 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.GenerateContentRequest;Creates a GenerateContentRequest 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 |
GenerateContentRequest |
GenerateContentRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for GenerateContentRequest
| 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 GenerateContentRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ai.generativelanguage.v1beta.GenerateContentRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a GenerateContentRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
GenerateContentRequest
GenerateContentRequest |
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 GenerateContentRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|