Class: DeepInfraEmbedding

DeepInfraEmbedding is an alias for DeepInfra that implements the BaseEmbedding interface.

Extends

• BaseEmbedding

Constructors

new DeepInfraEmbedding()

new DeepInfraEmbedding(init?): DeepInfraEmbedding

Parameters

• init?: Partial <DeepInfraEmbedding>

Returns

DeepInfraEmbedding

Overrides

BaseEmbedding . constructor

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:76

Properties

apiToken

apiToken: string

DeepInfra API token

See

https://deepinfra.com/dash/api_keys If not provided, it will try to get the token from the environment variable DEEPINFRA_API_TOKEN

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:50

---

embedBatchSize

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from

BaseEmbedding . embedBatchSize

Source

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

---

embedInfo?

optional embedInfo: EmbeddingInfo

Inherited from

BaseEmbedding . embedInfo

Source

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

---

maxRetries

maxRetries: number

Default

5

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:68

---

model

model: string

DeepInfra model to use

Default

"sentence-transformers/clip-ViT-B-32"

See

https://deepinfra.com/models/embeddings

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:42

---

queryPrefix

queryPrefix: string

Prefix to add to the query

Default

""

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:56

---

textPrefix

textPrefix: string

Prefix to add to the text

Default

""

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:62

---

timeout

timeout: number

Default

60 * 1000

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:74

Methods

getDeepInfraEmbedding()

private getDeepInfraEmbedding(inputs): Promise<number[][]>

Parameters

• inputs: string[]

Returns

Promise<number[][]>

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:116

---

getQueryEmbedding()

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

Parameters

• query: MessageContentDetail

Returns

Promise<null | number[]>

Overrides

BaseEmbedding . getQueryEmbedding

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:93

---

getQueryEmbeddings()

getQueryEmbeddings(queries): Promise<number[][]>

Parameters

• queries: string[]

Returns

Promise<number[][]>

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:111

---

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

• text: string

Returns

Promise<number[]>

Overrides

BaseEmbedding . getTextEmbedding

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:87

---

getTextEmbeddings()

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

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

Parameters

• texts: string[]

Returns

Promise<number[][]>

Overrides

BaseEmbedding . getTextEmbeddings

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:106

---

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:63

---

getUrl()

private getUrl(model): string

Parameters

• model: string

Returns

string

Source

packages/core/src/embeddings/DeepInfraEmbedding.ts:149

---

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:23

---

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:77