Namespace: Embed
Type Aliases
EmbedArgs
Ƭ EmbedArgs: Object
Type declaration
| Name | Type | Description |
|---|---|---|
text | string | The text to embed. |
Defined in
packages/mongodb-rag-core/build/embed/Embedder.d.ts:1
EmbedResult
Ƭ EmbedResult: Object
Type declaration
| Name | Type | Description |
|---|---|---|
embedding | number[] | Vector embedding of the text. |
Defined in
packages/mongodb-rag-core/build/embed/Embedder.d.ts:7
Embedder
Ƭ Embedder: Object
Takes a string of text and returns an array of numbers representing the vector embedding of the text.
Type declaration
| Name | Type |
|---|---|
embed | (args: EmbedArgs) => Promise<EmbedResult> |
Defined in
packages/mongodb-rag-core/build/embed/Embedder.d.ts:17
MakeLangChainEmbedderParams
Ƭ MakeLangChainEmbedderParams: Object
Type declaration
| Name | Type | Description |
|---|---|---|
langChainEmbeddings | Embeddings | LangChain.js Embeddings instance. You can configure things like caching and retry behavior in the Embeddings instance. |
Defined in
packages/mongodb-rag-core/build/embed/LangChainEmbedder.d.ts:3
MakeOpenAiEmbedderArgs
Ƭ MakeOpenAiEmbedderArgs: Object
Type declaration
| Name | Type | Description |
|---|---|---|
backoffOptions? | BackoffOptions | Options used for automatic retry (usually due to rate limiting). |
deployment | string | The deployment key. |
openAiClient | OpenAI | The OpenAI client. |
Defined in
packages/mongodb-rag-core/build/embed/OpenAiEmbedder.d.ts:4
Functions
makeLangChainEmbedder
▸ makeLangChainEmbedder(«destructured»): Embedder
Constructor for implementation of the Embedder using a LangChain.js Embeddings class.
Parameters
| Name | Type |
|---|---|
«destructured» | MakeLangChainEmbedderParams |
Returns
Defined in
packages/mongodb-rag-core/build/embed/LangChainEmbedder.d.ts:13
makeOpenAiEmbedder
▸ makeOpenAiEmbedder(«destructured»): Embedder
Constructor for implementation of the Embedder using OpenAI Embeddings API.
Parameters
| Name | Type |
|---|---|
«destructured» | MakeOpenAiEmbedderArgs |
Returns
Defined in
packages/mongodb-rag-core/build/embed/OpenAiEmbedder.d.ts:22