Skip to main content

Class: DeepInfraEmbedding()

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

Extends​

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

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

Type Parameters​

• Options extends Record<string, unknown>

Parameters​

• nodes: BaseNode<Metadata>[]

• options?: Options

Returns​

Promise<BaseNode<Metadata>[]>

Defined in​

packages/providers/deepinfra/dist/index.d.ts:19

Constructors​

new DeepInfraEmbedding()​

new DeepInfraEmbedding(init?): DeepInfraEmbedding

Parameters​

• init?: Partial<DeepInfraEmbedding>

Returns​

DeepInfraEmbedding

Overrides​

BaseEmbedding.constructor

Defined in​

packages/providers/deepinfra/dist/index.d.ts:53

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/providers/deepinfra/dist/index.d.ts:32

embedBatchSize​

embedBatchSize: number

Inherited from​

BaseEmbedding.embedBatchSize

Defined in​

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

embedInfo?​

optional embedInfo: EmbeddingInfo

Inherited from​

BaseEmbedding.embedInfo

Defined in​

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

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/providers/deepinfra/dist/index.d.ts:56

id​

id: string

Inherited from​

BaseEmbedding.id

Defined in​

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

maxRetries​

maxRetries: number

Default​

5

Defined in​

packages/providers/deepinfra/dist/index.d.ts:47

model​

model: string

DeepInfra model to use

Default​

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

See​

https://deepinfra.com/models/embeddings

Defined in​

packages/providers/deepinfra/dist/index.d.ts:25

queryPrefix​

queryPrefix: string

Prefix to add to the query

Default​

""

Defined in​

packages/providers/deepinfra/dist/index.d.ts:37

textPrefix​

textPrefix: string

Prefix to add to the text

Default​

""

Defined in​

packages/providers/deepinfra/dist/index.d.ts:42

timeout​

timeout: number

Default​

60 * 1000

Defined in​

packages/providers/deepinfra/dist/index.d.ts:52

Methods​

getQueryEmbedding()​

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

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Overrides​

BaseEmbedding.getQueryEmbedding

Defined in​

packages/providers/deepinfra/dist/index.d.ts:55

getQueryEmbeddings()​

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

Parameters​

• queries: string[]

Returns​

Promise<number[][]>

Defined in​

packages/providers/deepinfra/dist/index.d.ts:57

getTextEmbedding()​

getTextEmbedding(text): Promise<number[]>

Parameters​

• text: string

Returns​

Promise<number[]>

Overrides​

BaseEmbedding.getTextEmbedding

Defined in​

packages/providers/deepinfra/dist/index.d.ts:54

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

similarity()​

similarity(embedding1, embedding2, mode?): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode?: SimilarityType

Returns​

number

Inherited from​

BaseEmbedding.similarity

Defined in​

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

truncateMaxTokens()​

truncateMaxTokens(input): string[]

Parameters​

• input: string[]

Returns​

string[]

Inherited from​

BaseEmbedding.truncateMaxTokens

Defined in​

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