Skip to main content

Class: JinaAIEmbedding()

Extends

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

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:43

Constructors

new JinaAIEmbedding()

new JinaAIEmbedding(init?): JinaAIEmbedding

Parameters

init?: Partial<JinaAIEmbedding>

Returns

JinaAIEmbedding

Overrides

MultiModalEmbedding.constructor

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:78

Properties

apiKey

apiKey: string

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:44


baseURL

baseURL: string

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:46


dimensions?

optional dimensions: number

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:49


embedBatchSize

embedBatchSize: number

Inherited from

MultiModalEmbedding.embedBatchSize

Defined in

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


embedInfo?

optional embedInfo: EmbeddingInfo

Inherited from

MultiModalEmbedding.embedInfo

Defined in

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


encodingType?

optional encodingType: EncodingType

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:48


id

id: string

Inherited from

MultiModalEmbedding.id

Defined in

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


model

model: string

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:45


taskType

taskType: undefined | TaskType

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:47

Methods

getImageEmbedding()

getImageEmbedding(image): Promise<number[]>

Parameters

image: ImageType

Returns

Promise<number[]>

Overrides

MultiModalEmbedding.getImageEmbedding

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:56


getImageEmbeddings()

getImageEmbeddings(images): Promise<number[][]>

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

Parameters

images: ImageType[]

Returns

Promise<number[][]>

Overrides

MultiModalEmbedding.getImageEmbeddings

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:70


getQueryEmbedding()

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

Parameters

query: MessageContentDetail

Returns

Promise<null | number[]>

Inherited from

MultiModalEmbedding.getQueryEmbedding

Defined in

packages/llamaindex/src/embeddings/MultiModalEmbedding.ts:58


getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

text: string

Returns

Promise<number[]>

Overrides

MultiModalEmbedding.getTextEmbedding

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:51


getTextEmbeddings()

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

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

Parameters

texts: string[]

Returns

Promise<number[][]>

Overrides

MultiModalEmbedding.getTextEmbeddings

Defined in

packages/llamaindex/src/embeddings/JinaAIEmbedding.ts:63


getTextEmbeddingsBatch()

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

Get embeddings for a batch of texts

Parameters

texts: string[]

options?: BaseEmbeddingOptions

Returns

Promise<number[][]>

Inherited from

MultiModalEmbedding.getTextEmbeddingsBatch

Defined in

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


similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

embedding1: number[]

embedding2: number[]

mode?: SimilarityType

Returns

number

Inherited from

MultiModalEmbedding.similarity

Defined in

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


transform()

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

Parameters

nodes: BaseNode<Metadata>[]

_options?: any

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

MultiModalEmbedding.transform

Defined in

packages/llamaindex/src/embeddings/MultiModalEmbedding.ts:30


truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

input: string[]

Returns

string[]

Inherited from

MultiModalEmbedding.truncateMaxTokens

Defined in

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