Class: MistralAIEmbedding
Extends
Constructors
new MistralAIEmbedding()
new MistralAIEmbedding(
init
?):MistralAIEmbedding
Parameters
• init?: Partial
<MistralAIEmbedding
>
Returns
Overrides
Defined in
packages/llamaindex/src/embeddings/MistralAIEmbedding.ts:14
Properties
apiKey?
optional
apiKey:string
Defined in
packages/llamaindex/src/embeddings/MistralAIEmbedding.ts:10
embedBatchSize
embedBatchSize:
number
=DEFAULT_EMBED_BATCH_SIZE
Inherited from
Defined in
packages/llamaindex/src/embeddings/types.ts:21
embedInfo?
optional
embedInfo:EmbeddingInfo
Inherited from
Defined in
packages/llamaindex/src/embeddings/types.ts:22
model
model:
MISTRAL_EMBED
Defined in
packages/llamaindex/src/embeddings/MistralAIEmbedding.ts:9
Methods
getQueryEmbedding()
getQueryEmbedding(
query
):Promise
<null
|number
[]>
Parameters
• query: MessageContentDetail
Returns
Promise
<null
| number
[]>
Inherited from
BaseEmbedding
.getQueryEmbedding
Defined in
packages/llamaindex/src/embeddings/types.ts:34
getTextEmbedding()
getTextEmbedding(
text
):Promise
<number
[]>
Parameters
• text: string
Returns
Promise
<number
[]>
Overrides
BaseEmbedding
.getTextEmbedding
Defined in
packages/llamaindex/src/embeddings/MistralAIEmbedding.ts:30
getTextEmbeddings()
getTextEmbeddings(
texts
):Promise
<number
[][]>
Optionally override this method to retrieve multiple embeddings in a single request
Parameters
• texts: string
[]
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding
.getTextEmbeddings
Defined in
packages/llamaindex/src/embeddings/types.ts:48
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
Defined in
packages/llamaindex/src/embeddings/types.ts:64
similarity()
similarity(
embedding1
,embedding2
,mode
):number
Parameters
• embedding1: number
[]
• embedding2: number
[]
• mode: SimilarityType
= SimilarityType.DEFAULT
Returns
number
Inherited from
Defined in
packages/llamaindex/src/embeddings/types.ts:24
transform()
Parameters
• _options?: any
Returns
Inherited from
Defined in
packages/llamaindex/src/embeddings/types.ts:78
truncateMaxTokens()
truncateMaxTokens(
input
):string
[]
Parameters
• input: string
[]
Returns
string
[]
Inherited from
BaseEmbedding
.truncateMaxTokens