Class protos.google.ai.generativelanguage.v1.EmbedContentRequest (2.4.0)

Represents an EmbedContentRequest.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1.IEmbedContentRequest);

Constructs a new EmbedContentRequest.

Parameter
Name Description
properties IEmbedContentRequest

Properties to set

Properties

_outputDimensionality

public _outputDimensionality?: "outputDimensionality";

EmbedContentRequest _outputDimensionality.

_taskType

public _taskType?: "taskType";

EmbedContentRequest _taskType.

_title

public _title?: "title";

EmbedContentRequest _title.

content

public content?: (google.ai.generativelanguage.v1.IContent|null);

EmbedContentRequest content.

model

public model: string;

EmbedContentRequest model.

outputDimensionality

public outputDimensionality?: (number|null);

EmbedContentRequest outputDimensionality.

taskType

public taskType?: (google.ai.generativelanguage.v1.TaskType|keyof typeof google.ai.generativelanguage.v1.TaskType|null);

EmbedContentRequest taskType.

title

public title?: (string|null);

EmbedContentRequest title.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1.IEmbedContentRequest): google.ai.generativelanguage.v1.EmbedContentRequest;

Creates a new EmbedContentRequest instance using the specified properties.

Parameter
Name Description
properties IEmbedContentRequest

Properties to set

Returns
Type Description
EmbedContentRequest

EmbedContentRequest instance

decode(reader, length)

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

Decodes an EmbedContentRequest 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
EmbedContentRequest

EmbedContentRequest

decodeDelimited(reader)

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

Decodes an EmbedContentRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EmbedContentRequest

EmbedContentRequest

encode(message, writer)

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

Encodes the specified EmbedContentRequest message. Does not implicitly messages.

Parameters
Name Description
message IEmbedContentRequest

EmbedContentRequest 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.v1.IEmbedContentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEmbedContentRequest

EmbedContentRequest 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.v1.EmbedContentRequest;

Creates an EmbedContentRequest 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
EmbedContentRequest

EmbedContentRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EmbedContentRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EmbedContentRequest

EmbedContentRequest

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 an EmbedContentRequest 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