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