Class protos.google.ai.generativelanguage.v1beta.BidiGenerateContentServerContent (3.7.0)

Represents a BidiGenerateContentServerContent.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1beta.IBidiGenerateContentServerContent);

Constructs a new BidiGenerateContentServerContent.

Parameter
Name Description
properties IBidiGenerateContentServerContent

Properties to set

Properties

generationComplete

public generationComplete: boolean;

BidiGenerateContentServerContent generationComplete.

groundingMetadata

public groundingMetadata?: (google.ai.generativelanguage.v1beta.IGroundingMetadata|null);

BidiGenerateContentServerContent groundingMetadata.

inputTranscription

public inputTranscription?: (google.ai.generativelanguage.v1beta.IBidiGenerateContentTranscription|null);

BidiGenerateContentServerContent inputTranscription.

interrupted

public interrupted: boolean;

BidiGenerateContentServerContent interrupted.

modelTurn

public modelTurn?: (google.ai.generativelanguage.v1beta.IContent|null);

BidiGenerateContentServerContent modelTurn.

outputTranscription

public outputTranscription?: (google.ai.generativelanguage.v1beta.IBidiGenerateContentTranscription|null);

BidiGenerateContentServerContent outputTranscription.

turnComplete

public turnComplete: boolean;

BidiGenerateContentServerContent turnComplete.

urlContextMetadata

public urlContextMetadata?: (google.ai.generativelanguage.v1beta.IUrlContextMetadata|null);

BidiGenerateContentServerContent urlContextMetadata.

waitingForInput

public waitingForInput: boolean;

BidiGenerateContentServerContent waitingForInput.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.IBidiGenerateContentServerContent): google.ai.generativelanguage.v1beta.BidiGenerateContentServerContent;

Creates a new BidiGenerateContentServerContent instance using the specified properties.

Parameter
Name Description
properties IBidiGenerateContentServerContent

Properties to set

Returns
Type Description
BidiGenerateContentServerContent

BidiGenerateContentServerContent instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.BidiGenerateContentServerContent;

Decodes a BidiGenerateContentServerContent 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
BidiGenerateContentServerContent

BidiGenerateContentServerContent

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.BidiGenerateContentServerContent;

Decodes a BidiGenerateContentServerContent message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BidiGenerateContentServerContent

BidiGenerateContentServerContent

encode(message, writer)

public static encode(message: google.ai.generativelanguage.v1beta.IBidiGenerateContentServerContent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BidiGenerateContentServerContent message. Does not implicitly messages.

Parameters
Name Description
message IBidiGenerateContentServerContent

BidiGenerateContentServerContent 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.IBidiGenerateContentServerContent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BidiGenerateContentServerContent message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IBidiGenerateContentServerContent

BidiGenerateContentServerContent 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.BidiGenerateContentServerContent;

Creates a BidiGenerateContentServerContent 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
BidiGenerateContentServerContent

BidiGenerateContentServerContent

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for BidiGenerateContentServerContent

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 BidiGenerateContentServerContent to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ai.generativelanguage.v1beta.BidiGenerateContentServerContent, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a BidiGenerateContentServerContent message. Also converts values to other types if specified.

Parameters
Name Description
message BidiGenerateContentServerContent

BidiGenerateContentServerContent

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 BidiGenerateContentServerContent message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not