Logo
Classes

JinaAIEmbedding

Defined in: providers/jinaai/src/embedding.ts:44

Extends

  • MultiModalEmbedding

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

Defined in: providers/jinaai/src/embedding.ts:44

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Promise<BaseNode<Metadata>[]>

Constructors

new JinaAIEmbedding()

new JinaAIEmbedding(init?): JinaAIEmbedding

Defined in: providers/jinaai/src/embedding.ts:80

Parameters

init?

Partial<JinaAIEmbedding>

Returns

JinaAIEmbedding

Overrides

MultiModalEmbedding.constructor

Properties

apiKey

apiKey: string

Defined in: providers/jinaai/src/embedding.ts:45


model

model: string

Defined in: providers/jinaai/src/embedding.ts:46


baseURL

baseURL: string

Defined in: providers/jinaai/src/embedding.ts:47


task?

optional task: TaskType

Defined in: providers/jinaai/src/embedding.ts:48


encodingType?

optional encodingType: EncodingType

Defined in: providers/jinaai/src/embedding.ts:49


dimensions?

optional dimensions: number

Defined in: providers/jinaai/src/embedding.ts:50


late_chunking?

optional late_chunking: boolean

Defined in: providers/jinaai/src/embedding.ts:51

Methods

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Defined in: providers/jinaai/src/embedding.ts:53

Parameters

text

string

Returns

Promise<number[]>

Overrides

MultiModalEmbedding.getTextEmbedding


getImageEmbedding()

getImageEmbedding(image): Promise<number[]>

Defined in: providers/jinaai/src/embedding.ts:58

Parameters

image

ImageType

Returns

Promise<number[]>

Overrides

MultiModalEmbedding.getImageEmbedding


getTextEmbeddings()

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

Defined in: providers/jinaai/src/embedding.ts:65

Parameters

texts

string[]

Returns

Promise<number[][]>

Overrides

MultiModalEmbedding.getTextEmbeddings


getImageEmbeddings()

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

Defined in: providers/jinaai/src/embedding.ts:72

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

Parameters

images

ImageType[]

Returns

Promise<number[][]>

Overrides

MultiModalEmbedding.getImageEmbeddings