Skip to main content

Class: DeepInfraEmbedding

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

Extends

Constructors

new DeepInfraEmbedding()

new DeepInfraEmbedding(init?): DeepInfraEmbedding

Parameters

init?: Partial<DeepInfraEmbedding>

Returns

DeepInfraEmbedding

Overrides

BaseEmbedding.constructor

Defined in

packages/llamaindex/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

Defined in

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


embedBatchSize

embedBatchSize: number

Inherited from

BaseEmbedding.embedBatchSize

Defined in

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


embedInfo?

optional embedInfo: EmbeddingInfo

Inherited from

BaseEmbedding.embedInfo

Defined in

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


maxRetries

maxRetries: number

Default

5

Defined in

packages/llamaindex/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

Defined in

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


queryPrefix

queryPrefix: string

Prefix to add to the query

Default

""

Defined in

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


textPrefix

textPrefix: string

Prefix to add to the text

Default

""

Defined in

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


timeout

timeout: number

Default

60 * 1000

Defined in

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

Methods

getQueryEmbedding()

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

Parameters

query: MessageContentDetail

Returns

Promise<null | number[]>

Overrides

BaseEmbedding.getQueryEmbedding

Defined in

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


getQueryEmbeddings()

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

Parameters

queries: string[]

Returns

Promise<number[][]>

Defined in

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


getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

text: string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

Defined in

packages/llamaindex/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

Defined in

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


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/dist/embeddings/index.d.ts:49


similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

embedding1: number[]

embedding2: number[]

mode?: SimilarityType

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

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


transform()

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

Parameters

nodes: BaseNode<Metadata>[]

options?: BaseEmbeddingOptions

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseEmbedding.transform

Defined in

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


truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

input: string[]

Returns

string[]

Inherited from

BaseEmbedding.truncateMaxTokens

Defined in

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