Skip to main content

Class: GeminiEmbedding()

GeminiEmbedding is an alias for Gemini that implements the BaseEmbedding interface. Note: Vertex SDK currently does not support embeddings

Extends

GeminiEmbedding<Options>(nodes, options?): Promise<BaseNode<Metadata>[]>

GeminiEmbedding is an alias for Gemini that implements the BaseEmbedding interface. Note: Vertex SDK currently does not support embeddings

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

packages/llamaindex/src/embeddings/GeminiEmbedding.ts:14

Constructors

new GeminiEmbedding()

new GeminiEmbedding(init?): GeminiEmbedding

Parameters

init?: Partial<GeminiEmbedding>

Returns

GeminiEmbedding

Overrides

BaseEmbedding.constructor

Defined in

packages/llamaindex/src/embeddings/GeminiEmbedding.ts:18

Properties

embedBatchSize

embedBatchSize: number

Inherited from

BaseEmbedding.embedBatchSize

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:34


embedInfo?

optional embedInfo: EmbeddingInfo

Inherited from

BaseEmbedding.embedInfo

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:35


getTextEmbeddings()

getTextEmbeddings: (texts) => Promise<number[][]>

Optionally override this method to retrieve multiple embeddings in a single request

Parameters

texts: string[]

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddings

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:44


id

id: string

Inherited from

BaseEmbedding.id

Defined in

packages/core/schema/dist/schema/index.d.ts:171


model

model: GEMINI_EMBEDDING_MODEL

Defined in

packages/llamaindex/src/embeddings/GeminiEmbedding.ts:15


session

session: GeminiSession

Defined in

packages/llamaindex/src/embeddings/GeminiEmbedding.ts:16

Methods

getQueryEmbedding()

getQueryEmbedding(query): Promise<null | number[]>

Parameters

query: MessageContentDetail

Returns

Promise<null | number[]>

Inherited from

BaseEmbedding.getQueryEmbedding

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:39


getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

text: string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

Defined in

packages/llamaindex/src/embeddings/GeminiEmbedding.ts:36


getTextEmbeddingsBatch()

getTextEmbeddingsBatch(texts, options?): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

texts: string[]

options?: BaseEmbeddingOptions

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddingsBatch

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:50


similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

embedding1: number[]

embedding2: number[]

mode?: SimilarityType

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:37


truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

input: string[]

Returns

string[]

Inherited from

BaseEmbedding.truncateMaxTokens

Defined in

packages/core/embeddings/dist/embeddings/index.d.ts:51