Skip to main content

Namespace: Llm

Interfaces

Type Aliases

OpenAIChatCompletionWithoutUsage

Ƭ OpenAIChatCompletionWithoutUsage: Omit<OpenAI.ChatCompletion, "usage">

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:68


OpenAiAwaitedResponse

Ƭ OpenAiAwaitedResponse: Partial<OpenAI.ChatCompletionMessage> & Pick<OpenAI.ChatCompletionMessage, "content" | "role">

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:70


OpenAiChatMessage

Ƭ OpenAiChatMessage: OpenAI.ChatCompletionMessageParam & { content: string | null ; embedding?: number[] ; role: OpenAiMessageRole }

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:13


OpenAiMessageRole

Ƭ OpenAiMessageRole: "system" | "assistant" | "user" | "function"

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:12


OpenAiStreamingResponse

Ƭ OpenAiStreamingResponse: AsyncIterable<Omit<OpenAI.ChatCompletionChunk, "model" | "object">>

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:69


SystemPrompt

Ƭ SystemPrompt: OpenAiChatMessage & { content: string ; role: "system" }

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:24


ToolCallDirective

Ƭ ToolCallDirective: OpenAI.ChatCompletionFunctionCallOption

Defined in

packages/mongodb-rag-core/build/llm/ChatLlm.d.ts:87

Functions

makeLangchainChatLlm

makeLangchainChatLlm(«destructured»): ChatLlm

Use any Langchain JS ChatModel to talk to an LLM.

Note: This ChatLLM does not currently support tool calling.

Parameters

NameType
«destructured»MakeLangchainChatLlmProps

Returns

ChatLlm

Defined in

packages/mongodb-rag-core/build/llm/LangchainChatLlm.d.ts:13


makeOpenAiChatLlm

makeOpenAiChatLlm(«destructured»): Required<ChatLlm>

Construct the ChatLlm service using the OpenAI client.

Parameters

NameType
«destructured»MakeOpenAiChatLlmParams

Returns

Required<ChatLlm>

Defined in

packages/mongodb-rag-core/build/llm/OpenAiChatLlm.d.ts:15