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​

Constructors​

new GeminiEmbedding()​

new GeminiEmbedding(init?): GeminiEmbedding

Parameters​

• init?: Partial <GeminiEmbedding>

Returns​

GeminiEmbedding

Overrides​

BaseEmbedding . constructor

Source​

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

Properties​

embedBatchSize​

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from​

BaseEmbedding . embedBatchSize

Source​

packages/core/src/embeddings/types.ts:13

model​

model: GEMINI_EMBEDDING_MODEL

Source​

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

session​

session: GeminiSession

Source​

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

Methods​

getEmbedding()​

private getEmbedding(prompt): Promise<number[]>

Parameters​

• prompt: string

Returns​

Promise<number[]>

Source​

packages/core/src/embeddings/GeminiEmbedding.ts:28

getQueryEmbedding()​

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

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Inherited from​

BaseEmbedding . getQueryEmbedding

Source​

packages/core/src/embeddings/types.ts:25

getTextEmbedding()​

getTextEmbedding(text): Promise<number[]>

Parameters​

• text: string

Returns​

Promise<number[]>

Overrides​

BaseEmbedding . getTextEmbedding

Source​

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

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

Source​

packages/core/src/embeddings/types.ts:39

getTextEmbeddingsBatch()​

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

Get embeddings for a batch of texts

Parameters​

• texts: string[]

• options?

• options.logProgress?: boolean

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding . getTextEmbeddingsBatch

Source​

packages/core/src/embeddings/types.ts:55

similarity()​

similarity(embedding1, embedding2, mode): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns​

number

Inherited from​

BaseEmbedding . similarity

Source​

packages/core/src/embeddings/types.ts:15

transform()​

transform(nodes, _options?): Promise <BaseNode <Metadata>[]>

Parameters​

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns​

Promise <BaseNode <Metadata>[]>

Inherited from​

BaseEmbedding . transform

Source​

packages/core/src/embeddings/types.ts:69