Class: MistralAIEmbedding
Hierarchy
-
↳
MistralAIEmbedding
Constructors
constructor
• new MistralAIEmbedding(init?
): MistralAIEmbedding
Parameters
Name | Type |
---|---|
init? | Partial <MistralAIEmbedding > |
Returns
Overrides
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:14
Properties
apiKey
• Optional
apiKey: string
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:10
embedBatchSize
• embedBatchSize: number
= DEFAULT_EMBED_BATCH_SIZE
Inherited from
Defined in
packages/core/src/embeddings/types.ts:9
model
• model: MISTRAL_EMBED
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:9
session
• Private
session: MistralAISession
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:12
Methods
getMistralAIEmbedding
▸ getMistralAIEmbedding(input
): Promise
<any
>
Parameters
Name | Type |
---|---|
input | string |
Returns
Promise
<any
>
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:20
getQueryEmbedding
▸ getQueryEmbedding(query
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
query | string |
Returns
Promise
<number
[]>
Overrides
BaseEmbedding.getQueryEmbedding
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:34
getTextEmbedding
▸ getTextEmbedding(text
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
text | string |
Returns
Promise
<number
[]>
Overrides
BaseEmbedding.getTextEmbedding
Defined in
packages/core/src/embeddings/MistralAIEmbedding.ts:30
getTextEmbeddings
▸ getTextEmbeddings(texts
): Promise
<number
[][]>
Optionally override this method to retrieve multiple embeddings in a single request
Parameters
Name | Type |
---|---|
texts | string [] |
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding.getTextEmbeddings
Defined in
packages/core/src/embeddings/types.ts:26
getTextEmbeddingsBatch
▸ getTextEmbeddingsBatch(texts
, options?
): Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
Name | Type |
---|---|
texts | string [] |
options? | Object |
options.logProgress? | boolean |
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding.getTextEmbeddingsBatch
Defined in
packages/core/src/embeddings/types.ts:42
similarity
▸ similarity(embedding1
, embedding2
, mode?
): number
Parameters
Name | Type | Default value |
---|---|---|
embedding1 | number [] | undefined |
embedding2 | number [] | undefined |
mode | SimilarityType | SimilarityType.DEFAULT |
Returns
number
Inherited from
Defined in
packages/core/src/embeddings/types.ts:11
transform
▸ transform(nodes
, _options?
): Promise
<BaseNode
<Metadata
>[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
_options? | any |