Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
Chatbot Root Component",id:"chatbot-root-component",level:3},{value:"ActionButtonTrigger",id:"actionbuttontrigger",level:3},{value:"FloatingActionButtonTrigger",id:"floatingactionbuttontrigger",level:3},{value:"InputBarTrigger",id:"inputbartrigger",level:3},{value:"ModalView",id:"modalview",level:3}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.a)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"chatbot-ui",children:"Chatbot UI"}),"\n",(0,s.jsx)(t.p,{children:"The MongoDB Chatbot UI is a React.js component library that you can use to build a chatbot UI."}),"\n",(0,s.jsx)(t.p,{children:"Currently, it's focused on internal MongoDB use cases. However, we may make it more generic in the future if there is sufficient external interest."}),"\n",(0,s.jsxs)(r,{children:[(0,s.jsx)("summary",{children:" Demo GIF "}),(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Chatbot UI Demo GIF",src:n(30368).Z+"",width:"1308",height:"1054"})})]}),"\n",(0,s.jsx)(t.h2,{id:"install",children:"Install"}),"\n",(0,s.jsxs)(t.p,{children:["Install the ",(0,s.jsx)(t.code,{children:"mongodb-chatbot-ui"})," package from npm. This contains the React.js components that you can use to build a chatbot UI."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"npm install mongodb-chatbot-ui\n"})}),"\n",(0,s.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-tsx",children:'import Chatbot, {\n FloatingActionButtonTrigger,\n InputBarTrigger,\n ModalView,\n MongoDbLegalDisclosure,\n mongoDbVerifyInformationMessage,\n} from "mongodb-chatbot-ui";\n\nfunction MyApp() {\n const suggestedPrompts = [\n "How do I create a new MongoDB Atlas cluster?",\n "Can MongoDB store lists of data?",\n "How does vector search work?",\n ];\n return (\n Chatbot Root Component",id:"chatbot-root-component",level:3},{value:"ActionButtonTrigger",id:"actionbuttontrigger",level:3},{value:"FloatingActionButtonTrigger",id:"floatingactionbuttontrigger",level:3},{value:"InputBarTrigger",id:"inputbartrigger",level:3},{value:"ModalView",id:"modalview",level:3}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.a)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"chatbot-ui",children:"Chatbot UI"}),"\n",(0,s.jsx)(t.p,{children:"The MongoDB Chatbot UI is a React.js component library that you can use to build a chatbot UI."}),"\n",(0,s.jsx)(t.p,{children:"Currently, it's focused on internal MongoDB use cases. However, we may make it more generic in the future if there is sufficient external interest."}),"\n",(0,s.jsxs)(r,{children:[(0,s.jsx)("summary",{children:" Demo GIF "}),(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Chatbot UI Demo GIF",src:n(30817).Z+"",width:"1308",height:"1054"})})]}),"\n",(0,s.jsx)(t.h2,{id:"install",children:"Install"}),"\n",(0,s.jsxs)(t.p,{children:["Install the ",(0,s.jsx)(t.code,{children:"mongodb-chatbot-ui"})," package from npm. This contains the React.js components that you can use to build a chatbot UI."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"npm install mongodb-chatbot-ui\n"})}),"\n",(0,s.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-tsx",children:'import Chatbot, {\n FloatingActionButtonTrigger,\n InputBarTrigger,\n ModalView,\n MongoDbLegalDisclosure,\n mongoDbVerifyInformationMessage,\n} from "mongodb-chatbot-ui";\n\nfunction MyApp() {\n const suggestedPrompts = [\n "How do I create a new MongoDB Atlas cluster?",\n "Can MongoDB store lists of data?",\n "How does vector search work?",\n ];\n return (\n ChatLlm",id:"configure-the-chatllm",level:2},{value:"Manage Previous Messages Sent to the LLM",id:"manage-previous-messages-sent-to-the-llm",level:2},{value:"Prompt Engineering",id:"prompt-engineering",level:2},{value:"System Prompt",id:"system-prompt",level:3},{value:"User Prompt",id:"user-prompt",level:3}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"chat-with-an-llm",children:"Chat with an LLM"}),"\n",(0,o.jsx)(n.p,{children:"This guide contains information on how you can use the MongoDB Chatbot Server\nto chat with a large language model (LLM)."}),"\n",(0,o.jsxs)(n.h2,{id:"configure-the-chatllm",children:["Configure the ",(0,o.jsx)(n.code,{children:"ChatLlm"})]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:(0,o.jsx)(n.code,{children:"ChatLlm"})})," is the interface\nbetween the chatbot server and the LLM."]}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server comes with an implementation of the ",(0,o.jsx)(n.code,{children:"ChatLlm"}),",\nwhich uses the OpenAI API. You could also implement your own ",(0,o.jsx)(n.code,{children:"ChatLlm"})," to\nuse a different language model or different configuration on the OpenAI API."]}),"\n",(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makeopenaichatllm",children:(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"})}),"\nconstructor function to create an ",(0,o.jsx)(n.code,{children:"OpenAiChatLlm"})," instance."]}),"\n",(0,o.jsx)(n.p,{children:"The following are useful things to keep in mind when using an LLM:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"What model to use."})," This is probably the single most important decision\nfor shaping the chatbot response. The quality and characteristics\nof different models vary greatly."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Model temperature."}),' The temperature of the model determines how "creative"\nthe model is. A higher temperature will result in more creative responses,\nbut also more errors.']}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Model max tokens."})," The maximum number of tokens that the model will generate.\nThis is useful for preventing the model from generating very long responses,\nwhich impacts cost and quality."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Prompt engineering."})," What additional information to include in the prompt\nto guide the model's behavior. For more information, refer to the\n",(0,o.jsx)(n.a,{href:"#prompt-engineering",children:"Prompt Engineering"})," section."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Tools."})," What tools to give the model to use. For more information, refer to the\n",(0,o.jsx)(n.a,{href:"/chatbot/server/tools",children:"Tool Calling"})," guide."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example implementation of ",(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeOpenAiChatLlm, OpenAiChatMessage } from "mongodb-chatbot-server";\nimport { someTool } from "./someTool";\nexport const openAiClient = new OpenAIClient(\n OPENAI_ENDPOINT,\n new AzureKeyCredential(OPENAI_API_KEY)\n);\n\nexport const llm = makeOpenAiChatLlm({\n openAiClient,\n deployment: OPENAI_CHAT_COMPLETION_DEPLOYMENT,\n openAiLmmConfigOptions: {\n temperature: 0,\n maxTokens: 500,\n },\n tools: [someTool],\n});\n'})}),"\n",(0,o.jsxs)(n.admonition,{title:"Both OpenAI API and Azure OpenAI Service Supported",type:"note",children:[(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"})," supports both the OpenAI API and Azure OpenAI Service.\nIt wraps the ",(0,o.jsx)(n.code,{children:"@azure/openai"})," package, which supports both of these services."]}),(0,o.jsxs)(n.p,{children:["To use the ",(0,o.jsx)(n.code,{children:"@azure/openai"})," package with the OpenAI API,\nrefer to ",(0,o.jsx)(n.a,{href:"https://www.npmjs.com/package/@azure/openai#using-an-api-key-from-openai",children:"this documentation"}),"."]})]}),"\n",(0,o.jsx)(n.h2,{id:"manage-previous-messages-sent-to-the-llm",children:"Manage Previous Messages Sent to the LLM"}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server always sends the ",(0,o.jsx)(n.strong,{children:"current"})," user message to the LLM."]}),"\n",(0,o.jsxs)(n.p,{children:["You can also manage which ",(0,o.jsx)(n.strong,{children:"previous"})," messages in a conversation the MongoDB Chatbot Server sends to the LLM on each user message.\nYou might want to do this to allow for appropriate context to be sent to the LLM\nwithout exceeding the maximum number of tokens in the LLM's context window."]}),"\n",(0,o.jsxs)(n.p,{children:["You do this at the ",(0,o.jsx)(n.code,{children:"ConversationRouter"})," level with the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRouterParams#filterpreviousmessages",children:(0,o.jsx)(n.code,{children:"ConversationsRouterParams.filterPreviousMessages"})})," property.\nThe ",(0,o.jsx)(n.code,{children:"filterPreviousMessages"})," property accepts a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#filterpreviousmessages",children:(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})})," function."]}),"\n",(0,o.jsxs)(n.p,{children:["By default, the MongoDB Chatbot Server only send the initial system prompt\nand the user's current message to the LLM. You can change this behavior by\nimplementing your own ",(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})," function."]}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server package also comes with a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makefilternpreviousmessages",children:(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages"})}),"\nconstructor function. ",(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages"}),"\ncreates a ",(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})," function that returns the previous ",(0,o.jsx)(n.code,{children:"n"})," messages\nplus the initial system prompt."]}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example implementation of ",(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {\n makeFilterNPreviousMessages,\n ConversationsRouterParams,\n AppConfig,\n} from "mongodb-chatbot-server";\n\nconst filter10PreviousMessages = makeFilterNPreviousMessages(10);\n\nconst conversationsRouterConfig: ConversationsRouterParams = {\n filterPreviousMessages: filter10PreviousMessages,\n ...otherConfig,\n};\nconst appConfig: AppConfig = {\n conversationsRouterConfig,\n ...otherConfig,\n};\n'})}),"\n",(0,o.jsx)(n.h2,{id:"prompt-engineering",children:"Prompt Engineering"}),"\n",(0,o.jsx)(n.p,{children:"Prompt engineering is the process of directing the output of a language model\nto produce a desired response."}),"\n",(0,o.jsx)(n.p,{children:"In the context of a chatbot server such as this, there are the following main areas\nfor prompt engineering:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"System prompt: Message at the beginning of the conversation that guides the\nchatbot's behavior when generating responses."}),"\n",(0,o.jsx)(n.li,{children:"User prompt: User message that the chatbot uses to generate a response.\nIn RAG applications, this can include adding relevant content gathered from\nvector search results based on the user's input."}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"This guide does not cover prompt engineering techniques, but rather where you\ncan apply them in the MongoDB Chatbot Server."}),"\n",(0,o.jsxs)(n.p,{children:["Prompt engineering is a fairly new field, and best practices are still emerging.\nA great resource to learn more about prompt engineering is the ",(0,o.jsx)(n.a,{href:"https://www.promptingguide.ai/",children:"Prompt Engineering Guide"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"system-prompt",children:"System Prompt"}),"\n",(0,o.jsxs)(n.p,{children:["To add a system prompt, include a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#systemprompt",children:(0,o.jsx)(n.code,{children:"SystemPrompt"})})," message in your app's ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,o.jsx)(n.code,{children:"ConversationService"})}),"."]}),"\n",(0,o.jsx)(n.p,{children:"The system prompt is one of the most powerful way to customize the way\nthat the chatbot responds to users. You can use the system prompt to do things\nsuch as:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Control the style and personality of the chatbot."}),"\n",(0,o.jsx)(n.li,{children:"Determine how the chatbot responds to certain types of questions."}),"\n",(0,o.jsx)(n.li,{children:"Direct how the chatbot interprets user input and context information."}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If you're using the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makemongodbconversationsservice",children:(0,o.jsx)(n.code,{children:"makeMongoDbConversationsService()"})})," constructor function, add the system prompt\nas an argument:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {\n makeMongoDbConversationsService,\n SystemPrompt,\n} from "mongodb-chatbot-server";\nimport { MongoClient } from "mongodb";\n\n// System prompt for chatbot\nconst systemPrompt: SystemPrompt = {\n role: "system",\n content: `You are an assistant to users of the MongoDB Chatbot Framework.\nAnswer their questions about the framework in a friendly conversational tone.\nFormat your answers in Markdown.\nBe concise in your answers.\nIf you do not know the answer to the question based on the information provided,\nrespond: "I\'m sorry, I don\'t know the answer to that question. Please try to rephrase it. Refer to the below information to see if it helps."`,\n};\n\n// Create MongoDB collection and service for storing user conversations\n// with the chatbot.\nconst mongodb = new MongoClient(MONGODB_CONNECTION_URI);\nconst conversations = makeMongoDbConversationsService(\n mongodb.db(MONGODB_DATABASE_NAME),\n systemPrompt\n);\n'})}),"\n",(0,o.jsx)(n.h3,{id:"user-prompt",children:"User Prompt"}),"\n",(0,o.jsxs)(n.p,{children:["You can modify what the chatbot uses as the user prompt by implementing the\n",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})})," function."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})," takes in the user's query and previous messages in the conversation, then returns a new user message. For an overview of the ",(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})," function, refer to the ",(0,o.jsx)(n.a,{href:"/chatbot/server/user-message",children:"Generate User Message"})," guide."]}),"\n",(0,o.jsxs)(n.p,{children:["You might want to modify the user prompt if you're using a prompting technique\nlike retrieval augmented generation (RAG) or chain of thought.\nTo learn more about using RAG with the MongoDB Chatbot Server, refer to the\n",(0,o.jsx)(n.a,{href:"/chatbot/server/rag/",children:"RAG"})," guide."]})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var o=t(67294);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1c129967.1a143e39.js b/assets/js/1c129967.1a143e39.js
new file mode 100644
index 000000000..bd107326e
--- /dev/null
+++ b/assets/js/1c129967.1a143e39.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7597],{58006:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>h,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=t(85893),r=t(11151);const s={},i="Chat with an LLM",a={id:"server/llm",title:"Chat with an LLM",description:"This guide contains information on how you can use the MongoDB Chatbot Server",source:"@site/docs/server/llm.md",sourceDirName:"server",slug:"/server/llm",permalink:"/chatbot/server/llm",draft:!1,unlisted:!1,editUrl:"https://github.com/mongodb/chatbot/tree/main/docs/docs/server/llm.md",tags:[],version:"current",frontMatter:{},sidebar:"main",previous:{title:"Generate User Message",permalink:"/chatbot/server/user-message"},next:{title:"Retrieval Augmented Generation (RAG)",permalink:"/chatbot/server/rag/"}},h={},c=[{value:"Configure the ChatLlm",id:"configure-the-chatllm",level:2},{value:"Use OpenAI API",id:"use-openai-api",level:3},{value:"Use Langchain ChatModel",id:"use-langchain-chatmodel",level:3},{value:"Manage Previous Messages Sent to the LLM",id:"manage-previous-messages-sent-to-the-llm",level:2},{value:"Prompt Engineering",id:"prompt-engineering",level:2},{value:"System Prompt",id:"system-prompt",level:3},{value:"User Prompt",id:"user-prompt",level:3}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"chat-with-an-llm",children:"Chat with an LLM"}),"\n",(0,o.jsx)(n.p,{children:"This guide contains information on how you can use the MongoDB Chatbot Server\nto chat with a large language model (LLM)."}),"\n",(0,o.jsxs)(n.h2,{id:"configure-the-chatllm",children:["Configure the ",(0,o.jsx)(n.code,{children:"ChatLlm"})]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:(0,o.jsx)(n.code,{children:"ChatLlm"})})," is the interface\nbetween the chatbot server and the LLM."]}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server comes with an implementation of the ",(0,o.jsx)(n.code,{children:"ChatLlm"}),",\nwhich uses the OpenAI API. You could also implement your own ",(0,o.jsx)(n.code,{children:"ChatLlm"})," to\nuse a different language model or different configuration on the OpenAI API."]}),"\n",(0,o.jsx)(n.p,{children:"The following are useful things to keep in mind when using an LLM:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"What model to use."})," This is probably the single most important decision\nfor shaping the chatbot response. The quality and characteristics\nof different models vary greatly."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Model temperature."}),' The temperature of the model determines how "creative"\nthe model is. A higher temperature will result in more creative responses,\nbut also more errors.']}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Model max tokens."})," The maximum number of tokens that the model will generate.\nThis is useful for preventing the model from generating very long responses,\nwhich impacts cost and quality."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Prompt engineering."})," What additional information to include in the prompt\nto guide the model's behavior. For more information, refer to the\n",(0,o.jsx)(n.a,{href:"#prompt-engineering",children:"Prompt Engineering"})," section."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Tools."})," What tools to give the model to use. For more information, refer to the\n",(0,o.jsx)(n.a,{href:"/chatbot/server/tools",children:"Tool Calling"})," guide."]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"use-openai-api",children:"Use OpenAI API"}),"\n",(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makeopenaichatllm",children:(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"})}),"\nconstructor function to create a ",(0,o.jsx)(n.code,{children:"ChatLlm"})," that uses an OpenAI model like GPT-3.5."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"})," supports both the OpenAI API and Azure OpenAI Service.\nIt wraps the ",(0,o.jsx)(n.code,{children:"@azure/openai"})," package, which supports both of these services."]}),"\n",(0,o.jsxs)(n.p,{children:["To use the ",(0,o.jsx)(n.code,{children:"@azure/openai"})," package with the OpenAI API,\nrefer to ",(0,o.jsx)(n.a,{href:"https://www.npmjs.com/package/@azure/openai#using-an-api-key-from-openai",children:"this documentation"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example implementation of ",(0,o.jsx)(n.code,{children:"makeOpenAiChatLlm()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeOpenAiChatLlm, OpenAiChatMessage } from "mongodb-chatbot-server";\nimport { someTool } from "./someTool";\nexport const openAiClient = new OpenAIClient(\n OPENAI_ENDPOINT,\n new AzureKeyCredential(OPENAI_API_KEY)\n);\n\nexport const llm = makeOpenAiChatLlm({\n openAiClient,\n deployment: OPENAI_CHAT_COMPLETION_DEPLOYMENT,\n openAiLmmConfigOptions: {\n temperature: 0,\n maxTokens: 500,\n },\n tools: [someTool],\n});\n'})}),"\n",(0,o.jsxs)(n.h3,{id:"use-langchain-chatmodel",children:["Use Langchain ",(0,o.jsx)(n.code,{children:"ChatModel"})]}),"\n",(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makelangchainchatllm",children:(0,o.jsx)(n.code,{children:"makeLangchainChatLlm()"})})," constructor function to create a ",(0,o.jsx)(n.code,{children:"ChatLlm"})," that uses a Langchain ",(0,o.jsx)(n.code,{children:"ChatModel"}),". For more information on available ",(0,o.jsx)(n.code,{children:"ChatModel"})," implementations, refer to the ",(0,o.jsx)(n.a,{href:"https://js.langchain.com/docs/integrations/chat/",children:"Chat Models"})," in the Langchain documentation."]}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example implementation of using ",(0,o.jsx)(n.code,{children:"makeLangchainChatLlm()"})," to\nuse Anthropic's Claude family of models:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeLangchainChatLlm } from "mongodb-chatbot-server";\nimport { ChatAnthropic } from "@langchain/anthropic";\n\nconst anthropicModel = new ChatAnthropic({\n temperature: 0.9,\n anthropicApiKey: "YOUR-API-KEY",\n maxTokensToSample: 1024,\n});\nconst anthropicChatLlm = makeLangchainChatLlm({ chatModel: anthropicModel });\n'})}),"\n",(0,o.jsx)(n.h2,{id:"manage-previous-messages-sent-to-the-llm",children:"Manage Previous Messages Sent to the LLM"}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server always sends the ",(0,o.jsx)(n.strong,{children:"current"})," user message to the LLM."]}),"\n",(0,o.jsxs)(n.p,{children:["You can also manage which ",(0,o.jsx)(n.strong,{children:"previous"})," messages in a conversation the MongoDB Chatbot Server sends to the LLM on each user message.\nYou might want to do this to allow for appropriate context to be sent to the LLM\nwithout exceeding the maximum number of tokens in the LLM's context window."]}),"\n",(0,o.jsxs)(n.p,{children:["You do this at the ",(0,o.jsx)(n.code,{children:"ConversationRouter"})," level with the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRouterParams#filterpreviousmessages",children:(0,o.jsx)(n.code,{children:"ConversationsRouterParams.filterPreviousMessages"})})," property.\nThe ",(0,o.jsx)(n.code,{children:"filterPreviousMessages"})," property accepts a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#filterpreviousmessages",children:(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})})," function."]}),"\n",(0,o.jsxs)(n.p,{children:["By default, the MongoDB Chatbot Server only send the initial system prompt\nand the user's current message to the LLM. You can change this behavior by\nimplementing your own ",(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})," function."]}),"\n",(0,o.jsxs)(n.p,{children:["The MongoDB Chatbot Server package also comes with a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makefilternpreviousmessages",children:(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages"})}),"\nconstructor function. ",(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages"}),"\ncreates a ",(0,o.jsx)(n.code,{children:"FilterPreviousMessages"})," function that returns the previous ",(0,o.jsx)(n.code,{children:"n"})," messages\nplus the initial system prompt."]}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example implementation of ",(0,o.jsx)(n.code,{children:"makeFilterNPreviousMessages()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {\n makeFilterNPreviousMessages,\n ConversationsRouterParams,\n AppConfig,\n} from "mongodb-chatbot-server";\n\nconst filter10PreviousMessages = makeFilterNPreviousMessages(10);\n\nconst conversationsRouterConfig: ConversationsRouterParams = {\n filterPreviousMessages: filter10PreviousMessages,\n ...otherConfig,\n};\nconst appConfig: AppConfig = {\n conversationsRouterConfig,\n ...otherConfig,\n};\n'})}),"\n",(0,o.jsx)(n.h2,{id:"prompt-engineering",children:"Prompt Engineering"}),"\n",(0,o.jsx)(n.p,{children:"Prompt engineering is the process of directing the output of a language model\nto produce a desired response."}),"\n",(0,o.jsx)(n.p,{children:"In the context of a chatbot server such as this, there are the following main areas\nfor prompt engineering:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"System prompt: Message at the beginning of the conversation that guides the\nchatbot's behavior when generating responses."}),"\n",(0,o.jsx)(n.li,{children:"User prompt: User message that the chatbot uses to generate a response.\nIn RAG applications, this can include adding relevant content gathered from\nvector search results based on the user's input."}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"This guide does not cover prompt engineering techniques, but rather where you\ncan apply them in the MongoDB Chatbot Server."}),"\n",(0,o.jsxs)(n.p,{children:["Prompt engineering is a fairly new field, and best practices are still emerging.\nA great resource to learn more about prompt engineering is the ",(0,o.jsx)(n.a,{href:"https://www.promptingguide.ai/",children:"Prompt Engineering Guide"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"system-prompt",children:"System Prompt"}),"\n",(0,o.jsxs)(n.p,{children:["To add a system prompt, include a ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#systemprompt",children:(0,o.jsx)(n.code,{children:"SystemPrompt"})})," message in your app's ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,o.jsx)(n.code,{children:"ConversationService"})}),"."]}),"\n",(0,o.jsx)(n.p,{children:"The system prompt is one of the most powerful way to customize the way\nthat the chatbot responds to users. You can use the system prompt to do things\nsuch as:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Control the style and personality of the chatbot."}),"\n",(0,o.jsx)(n.li,{children:"Determine how the chatbot responds to certain types of questions."}),"\n",(0,o.jsx)(n.li,{children:"Direct how the chatbot interprets user input and context information."}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If you're using the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#makemongodbconversationsservice",children:(0,o.jsx)(n.code,{children:"makeMongoDbConversationsService()"})})," constructor function, add the system prompt\nas an argument:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {\n makeMongoDbConversationsService,\n SystemPrompt,\n} from "mongodb-chatbot-server";\nimport { MongoClient } from "mongodb";\n\n// System prompt for chatbot\nconst systemPrompt: SystemPrompt = {\n role: "system",\n content: `You are an assistant to users of the MongoDB Chatbot Framework.\nAnswer their questions about the framework in a friendly conversational tone.\nFormat your answers in Markdown.\nBe concise in your answers.\nIf you do not know the answer to the question based on the information provided,\nrespond: "I\'m sorry, I don\'t know the answer to that question. Please try to rephrase it. Refer to the below information to see if it helps."`,\n};\n\n// Create MongoDB collection and service for storing user conversations\n// with the chatbot.\nconst mongodb = new MongoClient(MONGODB_CONNECTION_URI);\nconst conversations = makeMongoDbConversationsService(\n mongodb.db(MONGODB_DATABASE_NAME),\n systemPrompt\n);\n'})}),"\n",(0,o.jsx)(n.h3,{id:"user-prompt",children:"User Prompt"}),"\n",(0,o.jsxs)(n.p,{children:["You can modify what the chatbot uses as the user prompt by implementing the\n",(0,o.jsx)(n.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})})," function."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})," takes in the user's query and previous messages in the conversation, then returns a new user message. For an overview of the ",(0,o.jsx)(n.code,{children:"GenerateUserPromptFunc"})," function, refer to the ",(0,o.jsx)(n.a,{href:"/chatbot/server/user-message",children:"Generate User Message"})," guide."]}),"\n",(0,o.jsxs)(n.p,{children:["You might want to modify the user prompt if you're using a prompting technique\nlike retrieval augmented generation (RAG) or chain of thought.\nTo learn more about using RAG with the MongoDB Chatbot Server, refer to the\n",(0,o.jsx)(n.a,{href:"/chatbot/server/rag/",children:"RAG"})," guide."]})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var o=t(67294);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/217a4326.087c8d69.js b/assets/js/217a4326.087c8d69.js
deleted file mode 100644
index b771279a0..000000000
--- a/assets/js/217a4326.087c8d69.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4195],{50024:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var t=n(85893),s=n(11151);const a={id:"ToolCallParams",title:"Interface: ToolCallParams",sidebar_label:"ToolCallParams",sidebar_position:0,custom_edit_url:null},o=void 0,i={id:"reference/server/interfaces/ToolCallParams",title:"Interface: ToolCallParams",description:"Parameters for invoking a tool call.",source:"@site/docs/reference/server/interfaces/ToolCallParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ToolCallParams",permalink:"/chatbot/reference/server/interfaces/ToolCallParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ToolCallParams",title:"Interface: ToolCallParams",sidebar_label:"ToolCallParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Tool",permalink:"/chatbot/reference/server/interfaces/Tool"},next:{title:"Readme",permalink:"/chatbot/reference/core/"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"conversation",id:"conversation",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"dataStreamer",id:"datastreamer",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"functionArgs",id:"functionargs",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"request",id:"request",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.p,{children:"Parameters for invoking a tool call."}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"conversation",children:"conversation"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.code,{children:"Optional"})," ",(0,t.jsx)(r.strong,{children:"conversation"}),": ",(0,t.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,t.jsx)(r.code,{children:"Conversation"})}),"<",(0,t.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,t.jsx)(r.code,{children:"ConversationCustomData"})}),">"]}),"\n",(0,t.jsx)(r.p,{children:"Conversation in the DB. Useful for getting metadata to use in tool calls."}),"\n",(0,t.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L67",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:67"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"datastreamer",children:"dataStreamer"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.code,{children:"Optional"})," ",(0,t.jsx)(r.strong,{children:"dataStreamer"}),": ",(0,t.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/DataStreamer",children:(0,t.jsx)(r.code,{children:"DataStreamer"})})]}),"\n",(0,t.jsx)(r.p,{children:"Data streamer with connection open to send events to the client."}),"\n",(0,t.jsx)(r.p,{children:"For example, you could use this to send updates about\nwhat the tool is doing to the client."}),"\n",(0,t.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L76",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:76"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"functionargs",children:"functionArgs"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"functionArgs"}),": ",(0,t.jsx)(r.code,{children:"unknown"})]}),"\n",(0,t.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L62",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:62"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"request",children:"request"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.code,{children:"Optional"})," ",(0,t.jsx)(r.strong,{children:"request"}),": ",(0,t.jsx)(r.code,{children:"Request"}),"<",(0,t.jsx)(r.code,{children:"ParamsDictionary"}),", ",(0,t.jsx)(r.code,{children:"any"}),", ",(0,t.jsx)(r.code,{children:"any"}),", ",(0,t.jsx)(r.code,{children:"ParsedQs"}),", ",(0,t.jsx)(r.code,{children:"Record"}),"<",(0,t.jsx)(r.code,{children:"string"}),", ",(0,t.jsx)(r.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(r.p,{children:"Current Express.js request from the client.\nUseful for getting metadata to use in tool calls."}),"\n",(0,t.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L82",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:82"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},11151:(e,r,n)=>{n.d(r,{Z:()=>i,a:()=>o});var t=n(67294);const s={},a=t.createContext(s);function o(e){const r=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(a.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/217a4326.35e3bc9b.js b/assets/js/217a4326.35e3bc9b.js
new file mode 100644
index 000000000..3f72444d7
--- /dev/null
+++ b/assets/js/217a4326.35e3bc9b.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4195],{50024:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=r(85893),s=r(11151);const o={id:"ToolCallParams",title:"Interface: ToolCallParams",sidebar_label:"ToolCallParams",sidebar_position:0,custom_edit_url:null},a=void 0,i={id:"reference/server/interfaces/ToolCallParams",title:"Interface: ToolCallParams",description:"Parameters for invoking a tool call.",source:"@site/docs/reference/server/interfaces/ToolCallParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ToolCallParams",permalink:"/chatbot/reference/server/interfaces/ToolCallParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ToolCallParams",title:"Interface: ToolCallParams",sidebar_label:"ToolCallParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Tool",permalink:"/chatbot/reference/server/interfaces/Tool"},next:{title:"Readme",permalink:"/chatbot/reference/core/"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"conversation",id:"conversation",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"dataStreamer",id:"datastreamer",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"functionArgs",id:"functionargs",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"request",id:"request",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"Parameters for invoking a tool call."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"conversation",children:"conversation"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"conversation"}),": ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,t.jsx)(n.code,{children:"Conversation"})}),"<",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,t.jsx)(n.code,{children:"ConversationCustomData"})}),">"]}),"\n",(0,t.jsx)(n.p,{children:"Conversation in the DB. Useful for getting metadata to use in tool calls."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L67",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:67"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"datastreamer",children:"dataStreamer"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"dataStreamer"}),": ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/DataStreamer",children:(0,t.jsx)(n.code,{children:"DataStreamer"})})]}),"\n",(0,t.jsx)(n.p,{children:"Data streamer with connection open to send events to the client."}),"\n",(0,t.jsx)(n.p,{children:"For example, you could use this to send updates about\nwhat the tool is doing to the client."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L76",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:76"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"functionargs",children:"functionArgs"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"functionArgs"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L62",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:62"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"request",children:"request"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"request"}),": ",(0,t.jsx)(n.code,{children:"Request"}),"<",(0,t.jsx)(n.code,{children:"ParamsDictionary"}),", ",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"ParsedQs"}),", ",(0,t.jsx)(n.code,{children:"Record"}),"<",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(n.p,{children:"Current Express.js request from the client.\nUseful for getting metadata to use in tool calls."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L82",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:82"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>a});var t=r(67294);const s={},o=t.createContext(s);function a(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/21f447ab.4e125db1.js b/assets/js/21f447ab.4e125db1.js
deleted file mode 100644
index bb9c784e7..000000000
--- a/assets/js/21f447ab.4e125db1.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1052],{31935:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var o=r(85893),s=r(11151);const t={id:"sources.SnootyProject",title:"Interface: SnootyProject",sidebar_label:"sources.SnootyProject",custom_edit_url:null},c=void 0,i={id:"reference/ingest/interfaces/sources.SnootyProject",title:"Interface: SnootyProject",description:"sources.SnootyProject",source:"@site/docs/reference/ingest/interfaces/sources.SnootyProject.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.SnootyProject",permalink:"/chatbot/reference/ingest/interfaces/sources.SnootyProject",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.SnootyProject",title:"Interface: SnootyProject",sidebar_label:"sources.SnootyProject",custom_edit_url:null},sidebar:"main",previous:{title:"sources.ProjectBase",permalink:"/chatbot/reference/ingest/interfaces/sources.ProjectBase"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"branches",id:"branches",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"project",id:"project",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"repoName",id:"reponame",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".SnootyProject"]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"branches",children:"branches"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"branches"}),": ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/interfaces/sources.Branch",children:(0,o.jsx)(n.code,{children:"Branch"})}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"Branches of repo that correspond to a site"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L261",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:261"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"project",children:"project"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"project"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"Snooty project name"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Example"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"kotlin"\n'})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L257",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:257"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"reponame",children:"repoName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"repoName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"Snooty repo name"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Example"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"docs-kotlin"\n'})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L252",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:252"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>c});var o=r(67294);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/21f447ab.6767d89c.js b/assets/js/21f447ab.6767d89c.js
new file mode 100644
index 000000000..200761fdc
--- /dev/null
+++ b/assets/js/21f447ab.6767d89c.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1052],{31935:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var o=r(85893),s=r(11151);const t={id:"sources.SnootyProject",title:"Interface: SnootyProject",sidebar_label:"sources.SnootyProject",custom_edit_url:null},c=void 0,i={id:"reference/ingest/interfaces/sources.SnootyProject",title:"Interface: SnootyProject",description:"sources.SnootyProject",source:"@site/docs/reference/ingest/interfaces/sources.SnootyProject.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.SnootyProject",permalink:"/chatbot/reference/ingest/interfaces/sources.SnootyProject",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.SnootyProject",title:"Interface: SnootyProject",sidebar_label:"sources.SnootyProject",custom_edit_url:null},sidebar:"main",previous:{title:"sources.ProjectBase",permalink:"/chatbot/reference/ingest/interfaces/sources.ProjectBase"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"branches",id:"branches",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"project",id:"project",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"repoName",id:"reponame",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".SnootyProject"]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"branches",children:"branches"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"branches"}),": ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/interfaces/sources.Branch",children:(0,o.jsx)(n.code,{children:"Branch"})}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"Branches of repo that correspond to a site"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L261",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:261"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"project",children:"project"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"project"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"Snooty project name"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Example"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"kotlin"\n'})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L257",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:257"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"reponame",children:"repoName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"repoName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"Snooty repo name"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Example"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"docs-kotlin"\n'})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L252",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:252"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>c});var o=r(67294);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/2352c6d6.80e6a360.js b/assets/js/2352c6d6.80e6a360.js
new file mode 100644
index 000000000..f50a0f1c2
--- /dev/null
+++ b/assets/js/2352c6d6.80e6a360.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8321],{48665:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=s(85893),t=s(11151);const o={id:"ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",sidebar_label:"ConversationsRouterLocals",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",description:"Express.js Request that exposes the app's ConversationsService.",source:"@site/docs/reference/server/interfaces/ConversationsRouterLocals.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",sidebar_label:"ConversationsRouterLocals",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRateLimitConfig",permalink:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig"},next:{title:"ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"conversations",id:"conversations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customData",id:"customdata",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Express.js Request that exposes the app's ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:"ConversationsService"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"This is useful if you want to do authentication or dynamic data validation."}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"conversations",children:"conversations"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"conversations"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,r.jsx)(n.code,{children:"ConversationsService"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L81",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:81"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"customdata",children:"customData"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"customData"}),": ",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L82",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:82"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},11151:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(67294);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/2352c6d6.8b03f709.js b/assets/js/2352c6d6.8b03f709.js
deleted file mode 100644
index 74bec8359..000000000
--- a/assets/js/2352c6d6.8b03f709.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8321],{48665:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(85893),t=n(11151);const o={id:"ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",sidebar_label:"ConversationsRouterLocals",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",description:"Express.js Request that exposes the app's ConversationsService.",source:"@site/docs/reference/server/interfaces/ConversationsRouterLocals.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRouterLocals",title:"Interface: ConversationsRouterLocals",sidebar_label:"ConversationsRouterLocals",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRateLimitConfig",permalink:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig"},next:{title:"ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"conversations",id:"conversations",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customData",id:"customdata",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(s.p,{children:["Express.js Request that exposes the app's ",(0,r.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:"ConversationsService"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"This is useful if you want to do authentication or dynamic data validation."}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"conversations",children:"conversations"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"conversations"}),": ",(0,r.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,r.jsx)(s.code,{children:"ConversationsService"})})]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L81",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:81"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"customdata",children:"customData"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customData"}),": ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"unknown"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L82",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:82"})})]})}function u(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},11151:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>i});var r=n(67294);const t={},o=r.createContext(t);function i(e){const s=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/6436e689.7a444dae.js b/assets/js/23fab249.d1f43531.js
similarity index 62%
rename from assets/js/6436e689.7a444dae.js
rename to assets/js/23fab249.d1f43531.js
index 904280582..c9f1c7d2d 100644
--- a/assets/js/6436e689.7a444dae.js
+++ b/assets/js/23fab249.d1f43531.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4966],{83769:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6628],{83769:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]);
\ No newline at end of file
diff --git a/assets/js/46ba77e2.1d227dfb.js b/assets/js/46ba77e2.1d227dfb.js
new file mode 100644
index 000000000..138110b97
--- /dev/null
+++ b/assets/js/46ba77e2.1d227dfb.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7954],{10398:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var t=r(85893),n=r(11151);const l={id:"ChatLlm",title:"Interface: ChatLlm",sidebar_label:"ChatLlm",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ChatLlm",title:"Interface: ChatLlm",description:"LLM that responds to user queries. Provides both streaming and awaited options.",source:"@site/docs/reference/server/interfaces/ChatLlm.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ChatLlm",permalink:"/chatbot/reference/server/interfaces/ChatLlm",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ChatLlm",title:"Interface: ChatLlm",sidebar_label:"ChatLlm",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CallToolResponse",permalink:"/chatbot/reference/server/interfaces/CallToolResponse"},next:{title:"CommentMessageParams",permalink:"/chatbot/reference/server/interfaces/CommentMessageParams"}},d={},c=[{value:"Methods",id:"methods",level:2},{value:"answerQuestionAwaited",id:"answerquestionawaited",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"answerQuestionStream",id:"answerquestionstream",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"callTool",id:"calltool",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.p,{children:"LLM that responds to user queries. Provides both streaming and awaited options."}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"answerquestionawaited",children:"answerQuestionAwaited"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"answerQuestionAwaited"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.code,{children:"ChatRequestAssistantMessage"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams",children:(0,t.jsx)(s.code,{children:"LlmAnswerQuestionParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.code,{children:"ChatRequestAssistantMessage"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L150",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:150"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"answerquestionstream",children:"answerQuestionStream"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"answerQuestionStream"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/modules#openaistreamingresponse",children:(0,t.jsx)(s.code,{children:"OpenAiStreamingResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams",children:(0,t.jsx)(s.code,{children:"LlmAnswerQuestionParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/modules#openaistreamingresponse",children:(0,t.jsx)(s.code,{children:"OpenAiStreamingResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L147",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:147"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"calltool",children:"callTool"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"callTool"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,t.jsx)(s.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmCallToolParams",children:(0,t.jsx)(s.code,{children:"LlmCallToolParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,t.jsx)(s.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L153",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:153"})})]})}function h(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},11151:(e,s,r)=>{r.d(s,{Z:()=>a,a:()=>i});var t=r(67294);const n={},l=t.createContext(n);function i(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/46ba77e2.54fb5802.js b/assets/js/46ba77e2.54fb5802.js
deleted file mode 100644
index 26133e202..000000000
--- a/assets/js/46ba77e2.54fb5802.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7954],{10398:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var t=r(85893),n=r(11151);const l={id:"ChatLlm",title:"Interface: ChatLlm",sidebar_label:"ChatLlm",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ChatLlm",title:"Interface: ChatLlm",description:"LLM that responds to user queries. Provides both streaming and awaited options.",source:"@site/docs/reference/server/interfaces/ChatLlm.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ChatLlm",permalink:"/chatbot/reference/server/interfaces/ChatLlm",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ChatLlm",title:"Interface: ChatLlm",sidebar_label:"ChatLlm",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CallToolResponse",permalink:"/chatbot/reference/server/interfaces/CallToolResponse"},next:{title:"CommentMessageParams",permalink:"/chatbot/reference/server/interfaces/CommentMessageParams"}},d={},c=[{value:"Methods",id:"methods",level:2},{value:"answerQuestionAwaited",id:"answerquestionawaited",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"answerQuestionStream",id:"answerquestionstream",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"callTool",id:"calltool",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.p,{children:"LLM that responds to user queries. Provides both streaming and awaited options."}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"answerquestionawaited",children:"answerQuestionAwaited"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"answerQuestionAwaited"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.code,{children:"ChatRequestAssistantMessage"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams",children:(0,t.jsx)(s.code,{children:"LlmAnswerQuestionParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.code,{children:"ChatRequestAssistantMessage"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L150",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:150"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"answerquestionstream",children:"answerQuestionStream"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"answerQuestionStream"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/modules#openaistreamingresponse",children:(0,t.jsx)(s.code,{children:"OpenAiStreamingResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams",children:(0,t.jsx)(s.code,{children:"LlmAnswerQuestionParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/modules#openaistreamingresponse",children:(0,t.jsx)(s.code,{children:"OpenAiStreamingResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L147",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:147"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"calltool",children:"callTool"}),"\n",(0,t.jsxs)(s.p,{children:["\u25b8 ",(0,t.jsx)(s.strong,{children:"callTool"}),"(",(0,t.jsx)(s.code,{children:"params"}),"): ",(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,t.jsx)(s.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"params"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/LlmCallToolParams",children:(0,t.jsx)(s.code,{children:"LlmCallToolParams"})})})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"Promise"}),"<",(0,t.jsx)(s.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,t.jsx)(s.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L153",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:153"})})]})}function h(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},11151:(e,s,r)=>{r.d(s,{Z:()=>a,a:()=>i});var t=r(67294);const n={},l=t.createContext(n);function i(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/47301a5f.156169c5.js b/assets/js/47301a5f.156169c5.js
deleted file mode 100644
index bf1d6bac7..000000000
--- a/assets/js/47301a5f.156169c5.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9136],{32067:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var s=r(85893),c=r(11151);const t={id:"sources.Branch",title:"Interface: Branch",sidebar_label:"sources.Branch",custom_edit_url:null},i=void 0,o={id:"reference/ingest/interfaces/sources.Branch",title:"Interface: Branch",description:"sources.Branch",source:"@site/docs/reference/ingest/interfaces/sources.Branch.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.Branch",permalink:"/chatbot/reference/ingest/interfaces/sources.Branch",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.Branch",title:"Interface: Branch",sidebar_label:"sources.Branch",custom_edit_url:null},sidebar:"main",previous:{title:"sources",permalink:"/chatbot/reference/ingest/modules/sources"},next:{title:"sources.DevCenterEntryTag",permalink:"/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fullUrl",id:"fullurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gitBranchName",id:"gitbranchname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isStableBranch",id:"isstablebranch",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".Branch"]}),"\n",(0,s.jsx)(n.p,{children:"Branch with site"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"active"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not the branch is active."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"true\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L232",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fullurl",children:"fullUrl"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fullUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Base URL of the site"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"https://mongodb.com/docs/kotlin/coroutine/upcoming"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L238",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gitbranchname",children:"gitBranchName"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"gitBranchName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Name of git branch"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"master"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L226",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:226"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isstablebranch",children:"isStableBranch"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"isStableBranch"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether this is the 'current, active branch' (rather than a previous or\nupcoming version)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L244",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:244"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var s=r(67294);const c={},t=s.createContext(c);function i(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/47301a5f.896b8113.js b/assets/js/47301a5f.896b8113.js
new file mode 100644
index 000000000..8ade04584
--- /dev/null
+++ b/assets/js/47301a5f.896b8113.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9136],{32067:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=r(85893),t=r(11151);const c={id:"sources.Branch",title:"Interface: Branch",sidebar_label:"sources.Branch",custom_edit_url:null},i=void 0,o={id:"reference/ingest/interfaces/sources.Branch",title:"Interface: Branch",description:"sources.Branch",source:"@site/docs/reference/ingest/interfaces/sources.Branch.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.Branch",permalink:"/chatbot/reference/ingest/interfaces/sources.Branch",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.Branch",title:"Interface: Branch",sidebar_label:"sources.Branch",custom_edit_url:null},sidebar:"main",previous:{title:"sources",permalink:"/chatbot/reference/ingest/modules/sources"},next:{title:"sources.DevCenterEntryTag",permalink:"/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fullUrl",id:"fullurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gitBranchName",id:"gitbranchname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isStableBranch",id:"isstablebranch",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".Branch"]}),"\n",(0,s.jsx)(n.p,{children:"Branch with site"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"active"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not the branch is active."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"true\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L232",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fullurl",children:"fullUrl"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fullUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Base URL of the site"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"https://mongodb.com/docs/kotlin/coroutine/upcoming"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L238",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gitbranchname",children:"gitBranchName"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"gitBranchName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Name of git branch"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"master"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L226",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:226"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isstablebranch",children:"isStableBranch"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"isStableBranch"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether this is the 'current, active branch' (rather than a previous or\nupcoming version)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts#L244",children:"mongodb-rag-ingest/src/sources/snooty/SnootyDataSource.ts:244"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var s=r(67294);const t={},c=s.createContext(t);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4c053673.1796cdf3.js b/assets/js/4c053673.1796cdf3.js
new file mode 100644
index 000000000..12d9ec352
--- /dev/null
+++ b/assets/js/4c053673.1796cdf3.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8753],{68367:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=i(85893),s=i(11151);const t={id:"AppConfig",title:"Interface: AppConfig",sidebar_label:"AppConfig",sidebar_position:0,custom_edit_url:null},o=void 0,c={id:"reference/server/interfaces/AppConfig",title:"Interface: AppConfig",description:"Configuration for the server Express.js app.",source:"@site/docs/reference/server/interfaces/AppConfig.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/AppConfig",permalink:"/chatbot/reference/server/interfaces/AppConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AppConfig",title:"Interface: AppConfig",sidebar_label:"AppConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Exports",permalink:"/chatbot/reference/server/modules"},next:{title:"AzureOpenAiServiceConfig",permalink:"/chatbot/reference/server/interfaces/AzureOpenAiServiceConfig"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiPrefix",id:"apiprefix",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"conversationsRouterConfig",id:"conversationsrouterconfig",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"corsOptions",id:"corsoptions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxRequestTimeoutMs",id:"maxrequesttimeoutms",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"serveStaticSite",id:"servestaticsite",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Configuration for the server Express.js app."}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiprefix",children:"apiPrefix"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"apiPrefix"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Prefix for all API routes. Defaults to ",(0,r.jsx)(n.code,{children:"/api/v1"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/app.ts#L45",children:"packages/mongodb-chatbot-server/src/app.ts:45"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"conversationsrouterconfig",children:"conversationsRouterConfig"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"conversationsRouterConfig"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRouterParams",children:(0,r.jsx)(n.code,{children:"ConversationsRouterParams"})})]}),"\n",(0,r.jsx)(n.p,{children:"Configuration for the conversations router."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/app.ts#L29",children:"packages/mongodb-chatbot-server/src/app.ts:29"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"corsoptions",children:"corsOptions"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"corsOptions"}),": ",(0,r.jsx)(n.code,{children:"CorsOptions"})]}),"\n",(0,r.jsx)(n.p,{children:"Configuration for CORS middleware. Defaults to allowing all origins."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/app.ts#L40",children:"packages/mongodb-chatbot-server/src/app.ts:40"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxrequesttimeoutms",children:"maxRequestTimeoutMs"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxRequestTimeoutMs"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Maximum time in milliseconds for a request to complete before timing out.\nDefaults to 60000 (1 minute)."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/app.ts#L35",children:"packages/mongodb-chatbot-server/src/app.ts:35"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"servestaticsite",children:"serveStaticSite"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"serveStaticSite"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(n.p,{children:["Whether to serve a static site from the root path (",(0,r.jsx)(n.code,{children:"GET https://my-site.com/"}),").\nDefaults to false.\nThis is useful for demo and testing purposes."]}),"\n",(0,r.jsx)(n.p,{children:"You should probably not include this in your production server.\nYou can control including this in dev/test/staging but not production\nwith an environment variable."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/app.ts#L56",children:"packages/mongodb-chatbot-server/src/app.ts:56"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},11151:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var r=i(67294);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4c053673.409f7949.js b/assets/js/4c053673.409f7949.js
deleted file mode 100644
index 8a62d6423..000000000
--- a/assets/js/4c053673.409f7949.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8753],{68367:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=r(85893),s=r(11151);const t={id:"AppConfig",title:"Interface: AppConfig",sidebar_label:"AppConfig",sidebar_position:0,custom_edit_url:null},o=void 0,c={id:"reference/server/interfaces/AppConfig",title:"Interface: AppConfig",description:"Configuration for the server Express.js app.",source:"@site/docs/reference/server/interfaces/AppConfig.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/AppConfig",permalink:"/chatbot/reference/server/interfaces/AppConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AppConfig",title:"Interface: AppConfig",sidebar_label:"AppConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Exports",permalink:"/chatbot/reference/server/modules"},next:{title:"AzureOpenAiServiceConfig",permalink:"/chatbot/reference/server/interfaces/AzureOpenAiServiceConfig"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiPrefix",id:"apiprefix",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"conversationsRouterConfig",id:"conversationsrouterconfig",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"corsOptions",id:"corsoptions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxRequestTimeoutMs",id:"maxrequesttimeoutms",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"serveStaticSite",id:"servestaticsite",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Configuration for the server Express.js app."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apiprefix",children:"apiPrefix"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"apiPrefix"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Prefix for all API routes. Defaults to ",(0,i.jsx)(n.code,{children:"/api/v1"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/app.ts#L45",children:"packages/mongodb-chatbot-server/src/app.ts:45"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"conversationsrouterconfig",children:"conversationsRouterConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"conversationsRouterConfig"}),": ",(0,i.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRouterParams",children:(0,i.jsx)(n.code,{children:"ConversationsRouterParams"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for the conversations router."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/app.ts#L29",children:"packages/mongodb-chatbot-server/src/app.ts:29"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"corsoptions",children:"corsOptions"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"corsOptions"}),": ",(0,i.jsx)(n.code,{children:"CorsOptions"})]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for CORS middleware. Defaults to allowing all origins."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/app.ts#L40",children:"packages/mongodb-chatbot-server/src/app.ts:40"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxrequesttimeoutms",children:"maxRequestTimeoutMs"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"maxRequestTimeoutMs"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsx)(n.p,{children:"Maximum time in milliseconds for a request to complete before timing out.\nDefaults to 60000 (1 minute)."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/app.ts#L35",children:"packages/mongodb-chatbot-server/src/app.ts:35"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"servestaticsite",children:"serveStaticSite"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"serveStaticSite"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to serve a static site from the root path (",(0,i.jsx)(n.code,{children:"GET https://my-site.com/"}),").\nDefaults to false.\nThis is useful for demo and testing purposes."]}),"\n",(0,i.jsx)(n.p,{children:"You should probably not include this in your production server.\nYou can control including this in dev/test/staging but not production\nwith an environment variable."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/app.ts#L56",children:"packages/mongodb-chatbot-server/src/app.ts:56"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(67294);const s={},t=i.createContext(s);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4e9b4fcd.107b5aa2.js b/assets/js/4e9b4fcd.107b5aa2.js
deleted file mode 100644
index 65843f913..000000000
--- a/assets/js/4e9b4fcd.107b5aa2.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5302],{17594:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=n(85893),t=n(11151);const c={id:"GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",sidebar_label:"GenerateUserPromptFuncReturnValue",sidebar_position:0,custom_edit_url:null},i=void 0,o={id:"reference/server/interfaces/GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",description:"Properties",source:"@site/docs/reference/server/interfaces/GenerateUserPromptFuncReturnValue.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/GenerateUserPromptFuncReturnValue",permalink:"/chatbot/reference/server/interfaces/GenerateUserPromptFuncReturnValue",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",sidebar_label:"GenerateUserPromptFuncReturnValue",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"FindByIdParams",permalink:"/chatbot/reference/server/interfaces/FindByIdParams"},next:{title:"LlmAnswerQuestionParams",permalink:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"references",id:"references",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"rejectQuery",id:"rejectquery",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"userMessage",id:"usermessage",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"references",children:"references"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"references"}),": { ",(0,s.jsx)(r.code,{children:"title"}),": ",(0,s.jsx)(r.code,{children:"string"})," ; ",(0,s.jsx)(r.code,{children:"url"}),": ",(0,s.jsx)(r.code,{children:"string"})," }[]"]}),"\n",(0,s.jsx)(r.p,{children:"References returned with the LLM response"}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L43",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:43"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"rejectquery",children:"rejectQuery"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"rejectQuery"}),": ",(0,s.jsx)(r.code,{children:"boolean"})]}),"\n",(0,s.jsxs)(r.p,{children:["User message used to send to LLM and store in the database.\nIf ",(0,s.jsx)(r.code,{children:"rejectQuery: true"}),", then the server gives a static response\nbefore sending the query to an LLM."]}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L36",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:36"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"usermessage",children:"userMessage"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"userMessage"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#usermessage",children:(0,s.jsx)(r.code,{children:"UserMessage"})})]}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L38",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:38"})})]})}function u(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},11151:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>i});var s=n(67294);const t={},c=s.createContext(t);function i(e){const r=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4e9b4fcd.b594ba95.js b/assets/js/4e9b4fcd.b594ba95.js
new file mode 100644
index 000000000..83b72922b
--- /dev/null
+++ b/assets/js/4e9b4fcd.b594ba95.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5302],{17594:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var s=n(85893),t=n(11151);const c={id:"GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",sidebar_label:"GenerateUserPromptFuncReturnValue",sidebar_position:0,custom_edit_url:null},o=void 0,i={id:"reference/server/interfaces/GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",description:"Properties",source:"@site/docs/reference/server/interfaces/GenerateUserPromptFuncReturnValue.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/GenerateUserPromptFuncReturnValue",permalink:"/chatbot/reference/server/interfaces/GenerateUserPromptFuncReturnValue",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GenerateUserPromptFuncReturnValue",title:"Interface: GenerateUserPromptFuncReturnValue",sidebar_label:"GenerateUserPromptFuncReturnValue",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"FindByIdParams",permalink:"/chatbot/reference/server/interfaces/FindByIdParams"},next:{title:"LlmAnswerQuestionParams",permalink:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"references",id:"references",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"rejectQuery",id:"rejectquery",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"userMessage",id:"usermessage",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"references",children:"references"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"references"}),": { ",(0,s.jsx)(r.code,{children:"title"}),": ",(0,s.jsx)(r.code,{children:"string"})," ; ",(0,s.jsx)(r.code,{children:"url"}),": ",(0,s.jsx)(r.code,{children:"string"})," }[]"]}),"\n",(0,s.jsx)(r.p,{children:"References returned with the LLM response"}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L43",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:43"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"rejectquery",children:"rejectQuery"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"rejectQuery"}),": ",(0,s.jsx)(r.code,{children:"boolean"})]}),"\n",(0,s.jsxs)(r.p,{children:["User message used to send to LLM and store in the database.\nIf ",(0,s.jsx)(r.code,{children:"rejectQuery: true"}),", then the server gives a static response\nbefore sending the query to an LLM."]}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L36",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:36"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"usermessage",children:"userMessage"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"userMessage"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#usermessage",children:(0,s.jsx)(r.code,{children:"UserMessage"})})]}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L38",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:38"})})]})}function u(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},11151:(e,r,n)=>{n.d(r,{Z:()=>i,a:()=>o});var s=n(67294);const t={},c=s.createContext(t);function o(e){const r=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(c.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/522e53fb.25b0c599.js b/assets/js/522e53fb.25b0c599.js
new file mode 100644
index 000000000..d6492162e
--- /dev/null
+++ b/assets/js/522e53fb.25b0c599.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6887],{51:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var n=t(85893),s=t(11151);const o={id:"Tool",title:"Interface: Tool",sidebar_label:"Tool",sidebar_position:0,custom_edit_url:null},i=void 0,l={id:"reference/server/interfaces/Tool",title:"Interface: Tool",description:"Tool for the chatbot to use.",source:"@site/docs/reference/server/interfaces/Tool.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/Tool",permalink:"/chatbot/reference/server/interfaces/Tool",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Tool",title:"Interface: Tool",sidebar_label:"Tool",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"SearchBooster",permalink:"/chatbot/reference/server/interfaces/SearchBooster"},next:{title:"ToolCallParams",permalink:"/chatbot/reference/server/interfaces/ToolCallParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"definition",id:"definition",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"call",id:"call",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.p,{children:"Tool for the chatbot to use."}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"definition",children:"definition"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"definition"}),": ",(0,n.jsx)(r.code,{children:"FunctionDefinition"})]}),"\n",(0,n.jsx)(r.p,{children:"Function definition for the LLM to invoke."}),"\n",(0,n.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L50",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:50"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"call"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"call"}),"(",(0,n.jsx)(r.code,{children:"args"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,n.jsx)(r.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Call the function based on the arguments in the ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Tool#definition",children:"Tool.definition"}),"."]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"args"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/ToolCallParams",children:(0,n.jsx)(r.code,{children:"ToolCallParams"})})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,n.jsx)(r.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L55",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:55"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},11151:(e,r,t)=>{t.d(r,{Z:()=>l,a:()=>i});var n=t(67294);const s={},o=n.createContext(s);function i(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/522e53fb.3707a104.js b/assets/js/522e53fb.3707a104.js
deleted file mode 100644
index fd05eacce..000000000
--- a/assets/js/522e53fb.3707a104.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6887],{51:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var n=t(85893),s=t(11151);const i={id:"Tool",title:"Interface: Tool",sidebar_label:"Tool",sidebar_position:0,custom_edit_url:null},o=void 0,l={id:"reference/server/interfaces/Tool",title:"Interface: Tool",description:"Tool for the chatbot to use.",source:"@site/docs/reference/server/interfaces/Tool.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/Tool",permalink:"/chatbot/reference/server/interfaces/Tool",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Tool",title:"Interface: Tool",sidebar_label:"Tool",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"SearchBooster",permalink:"/chatbot/reference/server/interfaces/SearchBooster"},next:{title:"ToolCallParams",permalink:"/chatbot/reference/server/interfaces/ToolCallParams"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"definition",id:"definition",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"call",id:"call",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.p,{children:"Tool for the chatbot to use."}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"definition",children:"definition"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"definition"}),": ",(0,n.jsx)(r.code,{children:"FunctionDefinition"})]}),"\n",(0,n.jsx)(r.p,{children:"Function definition for the LLM to invoke."}),"\n",(0,n.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L50",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:50"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"call"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"call"}),"(",(0,n.jsx)(r.code,{children:"args"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,n.jsx)(r.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Call the function based on the arguments in the ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Tool#definition",children:"Tool.definition"}),"."]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"args"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/ToolCallParams",children:(0,n.jsx)(r.code,{children:"ToolCallParams"})})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CallToolResponse",children:(0,n.jsx)(r.code,{children:"CallToolResponse"})}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/ChatLlm.ts#L55",children:"packages/mongodb-chatbot-server/src/services/ChatLlm.ts:55"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},11151:(e,r,t)=>{t.d(r,{Z:()=>l,a:()=>o});var n=t(67294);const s={},i=n.createContext(s);function o(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/52cccada.91f85053.js b/assets/js/52cccada.91f85053.js
deleted file mode 100644
index a1a6ccba6..000000000
--- a/assets/js/52cccada.91f85053.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4625],{89751:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=o(85893),t=o(11151);const s={id:"ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",sidebar_label:"ConversationsRateLimitConfig",sidebar_position:0,custom_edit_url:null},r=void 0,a={id:"reference/server/interfaces/ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",description:"Configuration for rate limiting on the /conversations/* routes.",source:"@site/docs/reference/server/interfaces/ConversationsRateLimitConfig.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRateLimitConfig",permalink:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",sidebar_label:"ConversationsRateLimitConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationConstants",permalink:"/chatbot/reference/server/interfaces/ConversationConstants"},next:{title:"ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"addMessageRateLimitConfig",id:"addmessageratelimitconfig",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"addMessageSlowDownConfig",id:"addmessageslowdownconfig",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"routerRateLimitConfig",id:"routerratelimitconfig",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"routerSlowDownConfig",id:"routerslowdownconfig",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Configuration for rate limiting on the /conversations/* routes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"addmessageratelimitconfig",children:"addMessageRateLimitConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"addMessageRateLimitConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration for rate limiting on the POST /conversations/",":conversationId",'/messages route.\nSince this is the most "expensive" route as it calls the LLM,\nit could be more restrictive than the global rate limit.']}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L50",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:50"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addmessageslowdownconfig",children:"addMessageSlowDownConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"addMessageSlowDownConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration for slow down on the POST /conversations/",":conversationId",'/messages route.\nSince this is the most "expensive" route as it calls the LLM,\nit could be more restrictive than the global slow down.']}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L62",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:62"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"routerratelimitconfig",children:"routerRateLimitConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"routerRateLimitConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for rate limiting on ALL /conversations/* routes."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L43",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:43"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"routerslowdownconfig",children:"routerSlowDownConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"routerSlowDownConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for slow down on ALL /conversations/* routes."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L55",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:55"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},11151:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>r});var i=o(67294);const t={},s=i.createContext(t);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/52cccada.f39e7b33.js b/assets/js/52cccada.f39e7b33.js
new file mode 100644
index 000000000..3b8848f26
--- /dev/null
+++ b/assets/js/52cccada.f39e7b33.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4625],{89751:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=o(85893),t=o(11151);const s={id:"ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",sidebar_label:"ConversationsRateLimitConfig",sidebar_position:0,custom_edit_url:null},r=void 0,a={id:"reference/server/interfaces/ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",description:"Configuration for rate limiting on the /conversations/* routes.",source:"@site/docs/reference/server/interfaces/ConversationsRateLimitConfig.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRateLimitConfig",permalink:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRateLimitConfig",title:"Interface: ConversationsRateLimitConfig",sidebar_label:"ConversationsRateLimitConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationConstants",permalink:"/chatbot/reference/server/interfaces/ConversationConstants"},next:{title:"ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"addMessageRateLimitConfig",id:"addmessageratelimitconfig",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"addMessageSlowDownConfig",id:"addmessageslowdownconfig",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"routerRateLimitConfig",id:"routerratelimitconfig",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"routerSlowDownConfig",id:"routerslowdownconfig",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Configuration for rate limiting on the /conversations/* routes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"addmessageratelimitconfig",children:"addMessageRateLimitConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"addMessageRateLimitConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration for rate limiting on the POST /conversations/",":conversationId",'/messages route.\nSince this is the most "expensive" route as it calls the LLM,\nit could be more restrictive than the global rate limit.']}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L50",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:50"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addmessageslowdownconfig",children:"addMessageSlowDownConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"addMessageSlowDownConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration for slow down on the POST /conversations/",":conversationId",'/messages route.\nSince this is the most "expensive" route as it calls the LLM,\nit could be more restrictive than the global slow down.']}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L62",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:62"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"routerratelimitconfig",children:"routerRateLimitConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"routerRateLimitConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for rate limiting on ALL /conversations/* routes."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L43",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:43"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"routerslowdownconfig",children:"routerSlowDownConfig"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.code,{children:"Optional"})," ",(0,i.jsx)(n.strong,{children:"routerSlowDownConfig"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Configuration for slow down on ALL /conversations/* routes."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L55",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:55"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},11151:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>r});var i=o(67294);const t={},s=i.createContext(t);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/81770523.99df4a27.js b/assets/js/81770523.99df4a27.js
new file mode 100644
index 000000000..6e30485fa
--- /dev/null
+++ b/assets/js/81770523.99df4a27.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4352],{27534:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=r(85893),t=r(11151);const i={id:"sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",sidebar_label:"sources.MakeGitDataSourceParams",custom_edit_url:null},a=void 0,c={id:"reference/ingest/interfaces/sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",description:"sources.MakeGitDataSourceParams",source:"@site/docs/reference/ingest/interfaces/sources.MakeGitDataSourceParams.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.MakeGitDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",sidebar_label:"sources.MakeGitDataSourceParams",custom_edit_url:null},sidebar:"main",previous:{title:"sources.DevCenterEntryTag",permalink:"/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag"},next:{title:"sources.MakeLangChainDocumentLoaderDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"filter",id:"filter",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"handlePage",id:"handlepage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"repoOptions",id:"repooptions",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"repoUri",id:"repouri",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".MakeGitDataSourceParams"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"}),": ",(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources#filterfunc",children:(0,s.jsx)(n.code,{children:"FilterFunc"})})]}),"\n",(0,s.jsx)(n.p,{children:"Filter function for selecting files in the repo to parse to pages."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'(path: string) => path.endsWith(".html")\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L48",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:48"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlepage",children:"handlePage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"handlePage"}),": ",(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources#handlepagefunc",children:(0,s.jsx)(n.code,{children:"HandlePageFunc"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L55",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:55"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"metadata"}),": ",(0,s.jsx)(n.code,{children:"PageMetadata"})]}),"\n",(0,s.jsx)(n.p,{children:"Metadata to be included in all pages."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L53",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:53"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Name of project"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L27",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repooptions",children:"repoOptions"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"repoOptions"}),": ",(0,s.jsx)(n.code,{children:"TaskOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"simple-git"})," clone command."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Default"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'{ "--depth": 1 }\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L41",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repouri",children:"repoUri"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"repoUri"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"URI for git repo"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"https://github.com/mongodb/mongo-java-driver.git"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L34",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:34"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>a});var s=r(67294);const t={},i=s.createContext(t);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/81770523.c4268f76.js b/assets/js/81770523.c4268f76.js
deleted file mode 100644
index c50b1c5e2..000000000
--- a/assets/js/81770523.c4268f76.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4352],{27534:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=r(85893),a=r(11151);const t={id:"sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",sidebar_label:"sources.MakeGitDataSourceParams",custom_edit_url:null},i=void 0,c={id:"reference/ingest/interfaces/sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",description:"sources.MakeGitDataSourceParams",source:"@site/docs/reference/ingest/interfaces/sources.MakeGitDataSourceParams.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.MakeGitDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.MakeGitDataSourceParams",title:"Interface: MakeGitDataSourceParams",sidebar_label:"sources.MakeGitDataSourceParams",custom_edit_url:null},sidebar:"main",previous:{title:"sources.DevCenterEntryTag",permalink:"/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag"},next:{title:"sources.MakeLangChainDocumentLoaderDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"filter",id:"filter",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"handlePage",id:"handlepage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"repoOptions",id:"repooptions",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"repoUri",id:"repouri",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,a.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".MakeGitDataSourceParams"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"}),": ",(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources#filterfunc",children:(0,s.jsx)(n.code,{children:"FilterFunc"})})]}),"\n",(0,s.jsx)(n.p,{children:"Filter function for selecting files in the repo to parse to pages."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'(path: string) => path.endsWith(".html")\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L48",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:48"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlepage",children:"handlePage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"handlePage"}),": ",(0,s.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources#handlepagefunc",children:(0,s.jsx)(n.code,{children:"HandlePageFunc"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L55",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:55"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"metadata"}),": ",(0,s.jsx)(n.code,{children:"PageMetadata"})]}),"\n",(0,s.jsx)(n.p,{children:"Metadata to be included in all pages."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L53",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:53"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"Name of project"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L27",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repooptions",children:"repoOptions"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"repoOptions"}),": ",(0,s.jsx)(n.code,{children:"TaskOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"simple-git"})," clone command."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Default"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'{ "--depth": 1 }\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L41",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repouri",children:"repoUri"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"repoUri"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"URI for git repo"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"Example"})})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"https://github.com/mongodb/mongo-java-driver.git"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/GitDataSource.ts#L34",children:"mongodb-rag-ingest/src/sources/GitDataSource.ts:34"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var s=r(67294);const a={},t=s.createContext(a);function i(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/86e9bf51.60f6ab3f.js b/assets/js/86e9bf51.60f6ab3f.js
deleted file mode 100644
index a7b5575d4..000000000
--- a/assets/js/86e9bf51.60f6ab3f.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9201],{79143:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>o,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var n=t(85893),s=t(11151);const d={id:"DataStreamer",title:"Interface: DataStreamer",sidebar_label:"DataStreamer",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"reference/server/interfaces/DataStreamer",title:"Interface: DataStreamer",description:"Service that streams data to the client.",source:"@site/docs/reference/server/interfaces/DataStreamer.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/DataStreamer",permalink:"/chatbot/reference/server/interfaces/DataStreamer",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DataStreamer",title:"Interface: DataStreamer",sidebar_label:"DataStreamer",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService"},next:{title:"EmbeddedContent",permalink:"/chatbot/reference/server/interfaces/EmbeddedContent"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"connected",id:"connected",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"connect",id:"connect",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"disconnect",id:"disconnect",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stream",id:"stream",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"streamData",id:"streamdata",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function h(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.p,{children:"Service that streams data to the client."}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"connected",children:"connected"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"connected"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L98",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:98"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"connect",children:"connect"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"connect"}),"(",(0,n.jsx)(r.code,{children:"res"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"res"})}),(0,n.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,n.jsx)(r.code,{children:"Response"}),"<",(0,n.jsx)(r.code,{children:"any"}),", ",(0,n.jsx)(r.code,{children:"Record"}),"<",(0,n.jsx)(r.code,{children:"string"}),", ",(0,n.jsx)(r.code,{children:"any"}),">>"]})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L99",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:99"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"disconnect",children:"disconnect"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"disconnect"}),"(): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L100",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:100"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stream",children:"stream"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"stream"}),"(",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"StreamParams"})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L102",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:102"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"streamdata",children:"streamData"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"streamData"}),"(",(0,n.jsx)(r.code,{children:"data"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"data"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#somestreamevent",children:(0,n.jsx)(r.code,{children:"SomeStreamEvent"})})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L101",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:101"})})]})}function o(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},11151:(e,r,t)=>{t.d(r,{Z:()=>c,a:()=>i});var n=t(67294);const s={},d=n.createContext(s);function i(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/86e9bf51.c9a43f28.js b/assets/js/86e9bf51.c9a43f28.js
new file mode 100644
index 000000000..57980b3af
--- /dev/null
+++ b/assets/js/86e9bf51.c9a43f28.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9201],{79143:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var n=t(85893),s=t(11151);const d={id:"DataStreamer",title:"Interface: DataStreamer",sidebar_label:"DataStreamer",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"reference/server/interfaces/DataStreamer",title:"Interface: DataStreamer",description:"Service that streams data to the client.",source:"@site/docs/reference/server/interfaces/DataStreamer.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/DataStreamer",permalink:"/chatbot/reference/server/interfaces/DataStreamer",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DataStreamer",title:"Interface: DataStreamer",sidebar_label:"DataStreamer",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService"},next:{title:"EmbeddedContent",permalink:"/chatbot/reference/server/interfaces/EmbeddedContent"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"connected",id:"connected",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"connect",id:"connect",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"disconnect",id:"disconnect",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stream",id:"stream",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"streamData",id:"streamdata",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.p,{children:"Service that streams data to the client."}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"connected",children:"connected"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"connected"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L98",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:98"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"connect",children:"connect"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"connect"}),"(",(0,n.jsx)(r.code,{children:"res"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"res"})}),(0,n.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,n.jsx)(r.code,{children:"Response"}),"<",(0,n.jsx)(r.code,{children:"any"}),", ",(0,n.jsx)(r.code,{children:"Record"}),"<",(0,n.jsx)(r.code,{children:"string"}),", ",(0,n.jsx)(r.code,{children:"any"}),">>"]})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L99",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:99"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"disconnect",children:"disconnect"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"disconnect"}),"(): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L100",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:100"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stream",children:"stream"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"stream"}),"(",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"StreamParams"})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L102",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:102"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"streamdata",children:"streamData"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 ",(0,n.jsx)(r.strong,{children:"streamData"}),"(",(0,n.jsx)(r.code,{children:"data"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"data"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#somestreamevent",children:(0,n.jsx)(r.code,{children:"SomeStreamEvent"})})})]})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-chatbot-server/src/services/dataStreamer.ts#L101",children:"packages/mongodb-chatbot-server/src/services/dataStreamer.ts:101"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},11151:(e,r,t)=>{t.d(r,{Z:()=>c,a:()=>i});var n=t(67294);const s={},d=n.createContext(s);function i(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/8a071b55.6a9e29a3.js b/assets/js/8a071b55.6a9e29a3.js
deleted file mode 100644
index 10092ef6e..000000000
--- a/assets/js/8a071b55.6a9e29a3.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4470],{98107:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>i});var r=a(85893),t=a(11151);const s={id:"sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",sidebar_label:"sources.MakeLangChainDocumentLoaderDataSourceParams",custom_edit_url:null},c=void 0,o={id:"reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",description:"sources.MakeLangChainDocumentLoaderDataSourceParams",source:"@site/docs/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",sidebar_label:"sources.MakeLangChainDocumentLoaderDataSourceParams",custom_edit_url:null},sidebar:"main",previous:{title:"sources.MakeGitDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams"},next:{title:"sources.MakeMongoDbUniversityDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeMongoDbUniversityDataSourceParams"}},d={},i=[{value:"Properties",id:"properties",level:2},{value:"documentLoader",id:"documentloader",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"transformLangchainDocumentToPage",id:"transformlangchaindocumenttopage",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".MakeLangChainDocumentLoaderDataSourceParams"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"documentloader",children:"documentLoader"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"documentLoader"}),": ",(0,r.jsx)(n.code,{children:"DocumentLoader"})]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://js.langchain.com/docs/modules/data_connection/document_loaders/",children:"Langchain document loader"})," to use to load documents."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L10",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:10"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"metadata"}),": ",(0,r.jsx)(n.code,{children:"PageMetadata"})]}),"\n",(0,r.jsx)(n.p,{children:"Metadata to use in the page metadata of all documents."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Page.metadata"})," generated with ",(0,r.jsx)(n.code,{children:"transformLangchainDocumentToPage()"}),"\noverrides this metadata if the properties have the same key."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L23",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:23"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"Name of the data source used by MongoDB RAG Ingest."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L15",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:15"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"transformlangchaindocumenttopage",children:"transformLangchainDocumentToPage"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"transformLangchainDocumentToPage"}),"(",(0,r.jsx)(n.code,{children:"doc"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"Omit"}),"<",(0,r.jsx)(n.code,{children:"Page"}),", ",(0,r.jsx)(n.code,{children:'"sourceName"'}),">>"]}),"\n",(0,r.jsxs)(n.p,{children:["Take the LangchainDocument returned by the ",(0,r.jsx)(n.code,{children:"documentLoader"}),"\nand transform it into the Page persisted in the PageStore."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"doc"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"Document"}),"<",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"any"}),">>"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"Omit"}),"<",(0,r.jsx)(n.code,{children:"Page"}),", ",(0,r.jsx)(n.code,{children:'"sourceName"'}),">>"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/nlarew/chatbot/blob/03a35c9/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L29",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:29"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},11151:(e,n,a)=>{a.d(n,{Z:()=>o,a:()=>c});var r=a(67294);const t={},s=r.createContext(t);function c(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/8a071b55.a3d8da0c.js b/assets/js/8a071b55.a3d8da0c.js
new file mode 100644
index 000000000..63be8453e
--- /dev/null
+++ b/assets/js/8a071b55.a3d8da0c.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4470],{98107:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>i});var r=a(85893),t=a(11151);const s={id:"sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",sidebar_label:"sources.MakeLangChainDocumentLoaderDataSourceParams",custom_edit_url:null},o=void 0,c={id:"reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",description:"sources.MakeLangChainDocumentLoaderDataSourceParams",source:"@site/docs/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams.md",sourceDirName:"reference/ingest/interfaces",slug:"/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"sources.MakeLangChainDocumentLoaderDataSourceParams",title:"Interface: MakeLangChainDocumentLoaderDataSourceParams",sidebar_label:"sources.MakeLangChainDocumentLoaderDataSourceParams",custom_edit_url:null},sidebar:"main",previous:{title:"sources.MakeGitDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams"},next:{title:"sources.MakeMongoDbUniversityDataSourceParams",permalink:"/chatbot/reference/ingest/interfaces/sources.MakeMongoDbUniversityDataSourceParams"}},d={},i=[{value:"Properties",id:"properties",level:2},{value:"documentLoader",id:"documentloader",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"transformLangchainDocumentToPage",id:"transformlangchaindocumenttopage",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/sources",children:"sources"}),".MakeLangChainDocumentLoaderDataSourceParams"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"documentloader",children:"documentLoader"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"documentLoader"}),": ",(0,r.jsx)(n.code,{children:"DocumentLoader"})]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://js.langchain.com/docs/modules/data_connection/document_loaders/",children:"Langchain document loader"})," to use to load documents."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L10",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:10"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"metadata"}),": ",(0,r.jsx)(n.code,{children:"PageMetadata"})]}),"\n",(0,r.jsx)(n.p,{children:"Metadata to use in the page metadata of all documents."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Page.metadata"})," generated with ",(0,r.jsx)(n.code,{children:"transformLangchainDocumentToPage()"}),"\noverrides this metadata if the properties have the same key."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L23",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:23"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"Name of the data source used by MongoDB RAG Ingest."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L15",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:15"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"transformlangchaindocumenttopage",children:"transformLangchainDocumentToPage"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"transformLangchainDocumentToPage"}),"(",(0,r.jsx)(n.code,{children:"doc"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"Omit"}),"<",(0,r.jsx)(n.code,{children:"Page"}),", ",(0,r.jsx)(n.code,{children:'"sourceName"'}),">>"]}),"\n",(0,r.jsxs)(n.p,{children:["Take the LangchainDocument returned by the ",(0,r.jsx)(n.code,{children:"documentLoader"}),"\nand transform it into the Page persisted in the PageStore."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"doc"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"Document"}),"<",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"any"}),">>"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"Omit"}),"<",(0,r.jsx)(n.code,{children:"Page"}),", ",(0,r.jsx)(n.code,{children:'"sourceName"'}),">>"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/6dba6ff/packages/mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts#L29",children:"mongodb-rag-ingest/src/sources/LangchainDocumentLoaderDataSource.ts:29"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},11151:(e,n,a)=>{a.d(n,{Z:()=>c,a:()=>o});var r=a(67294);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f19e16dd.93e84499.js b/assets/js/8e875b0a.fc0b90b9.js
similarity index 99%
rename from assets/js/f19e16dd.93e84499.js
rename to assets/js/8e875b0a.fc0b90b9.js
index 114880958..85c32b96a 100644
--- a/assets/js/f19e16dd.93e84499.js
+++ b/assets/js/8e875b0a.fc0b90b9.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8193],{41837:e=>{e.exports=JSON.parse('{"url":"redocusaurus/plugin-redoc-0.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.1.0","info":{"title":"MongoDB RAG Server API","version":"1.0.0","license":{"name":"Apache 2.0","url":"https://github.com/mongodb/chatbot/blob/main/LICENSE"},"description":"The MongoDB RAG Server API is a RESTful API that allows you to\\ncreate and manage conversations.\\nThe API is designed to be used by the MongoDB RAG UI frontend,\\nbut can also be used by other clients.\\n\\n**NOTE:** The default configuration requires capturing user IP address\\nand a header `Origin: some_string`. You can override this.\\nRefer to the server configuration documentation for more information.\\n"},"servers":[{"url":"http://Your Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(29901),a=n(39642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(16500).resolve(t)],delete Prism.languages[e],n(16500)(t),o.add(e)}))}i.silent=!1,e.exports=i},96854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,s=i.length;-1!==n.code.indexOf(a=t(r,s));)++s;return i[s]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(s){for(var l=0;lYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(29901),a=n(39642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(16500).resolve(t)],delete Prism.languages[e],n(16500)(t),o.add(e)}))}i.silent=!1,e.exports=i},96854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,s=i.length;-1!==n.code.indexOf(a=t(r,s));)++s;return i[s]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(s){for(var l=0;l