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.
Config",id:"config",level:2},{value:"IngestMetaStore",id:"ingestmetastore",level:2},{value:"PageStore",id:"pagestore",level:2},{value:"EmbeddedContentStore",id:"embeddedcontentstore",level:2},{value:"DataSource",id:"datasource",level:2},{value:"Embedder",id:"embedder",level:2},{value:"ChunkOptions",id:"chunkoptions",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"configuration-reference",children:"Configuration Reference"}),"\n",(0,t.jsx)(n.p,{children:"This page contains reference documentation for the configuration options for the MongoDB RAG Ingest CLI."}),"\n",(0,t.jsxs)(n.p,{children:["A Ingest CLI config files is a CommonJS file that exports a ",(0,t.jsx)(n.code,{children:"Config"})," object as its default export."]}),"\n",(0,t.jsxs)(n.p,{children:["For more information on setting up a configuration file, refer to the ",(0,t.jsx)(n.a,{href:"/chatbot/ingest/configure",children:"Configure"})," documentation."]}),"\n",(0,t.jsx)(n.p,{children:"To set up a configuration file, you must first install the following packages:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm install mongodb-rag-ingest mongodb-rag-core\n"})}),"\n",(0,t.jsx)(n.h2,{id:"api-reference",children:"API Reference"}),"\n",(0,t.jsxs)(n.p,{children:["For a full API reference of all modules exported by ",(0,t.jsx)(n.code,{children:"mongodb-rag-ingest"}),"\nand ",(0,t.jsx)(n.code,{children:"mongodb-rag-core"}),", refer to the ",(0,t.jsx)(n.a,{href:"../reference/",children:"API Reference"})," documentation."]}),"\n",(0,t.jsx)(n.p,{children:"This page links to the key reference documentation for configuring the Ingest CLI."}),"\n",(0,t.jsx)(n.h2,{id:"config",children:(0,t.jsx)(n.code,{children:"Config"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/#config",children:(0,t.jsx)(n.code,{children:"Config"})})," type is the root configuration type for the Ingest CLI."]}),"\n",(0,t.jsx)(n.h2,{id:"ingestmetastore",children:(0,t.jsx)(n.code,{children:"IngestMetaStore"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"/chatbot/reference/ingest/modules#ingestmetastore",children:(0,t.jsx)(n.code,{children:"IngestMetaStore"})})," is an interface to interact with MongoDB collection that tracks metadata associated with the ingest process."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"IngestMetaStore"}),", you can use the function ",(0,t.jsx)(n.a,{href:"/chatbot/reference/ingest/modules#makeingestmetastore",children:(0,t.jsx)(n.code,{children:"makeIngestMetaStore()"})}),".\nThis function returns an ",(0,t.jsx)(n.code,{children:"IngestMetaStore"}),".\nThis ",(0,t.jsx)(n.code,{children:"IngestMetaStore"})," persists data in the ",(0,t.jsx)(n.code,{children:"ingest_meta"})," collection in MongoDB."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"IngestMetaStore"})," with ",(0,t.jsx)(n.code,{children:"makeIngestMetaStore()"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { makeIngestMetaStore } from "mongodb-rag-ingest";\n\nconst ingestMetaStore = makeIngestMetaStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n entryId: "all",\n});\n'})}),"\n",(0,t.jsx)(n.h2,{id:"pagestore",children:(0,t.jsx)(n.code,{children:"PageStore"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#pagestore",children:(0,t.jsx)(n.code,{children:"PageStore"})})," is an interface\nto interact with ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#page",children:(0,t.jsx)(n.code,{children:"Page"})})," data."]}),"\n",(0,t.jsxs)(n.p,{children:["To create a ",(0,t.jsx)(n.code,{children:"PageStore"})," that uses MongoDB to store pages, you can use the function\n",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#makemongodbpagestore",children:(0,t.jsx)(n.code,{children:"makeMongoDbPageStore()"})}),".\nThis function returns a ",(0,t.jsx)(n.code,{children:"PageStore"}),". This ",(0,t.jsx)(n.code,{children:"PageStore"})," persists data in the ",(0,t.jsx)(n.code,{children:"pages"})," collection in MongoDB."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"PageStore"})," with ",(0,t.jsx)(n.code,{children:"makeMongoDbPageStore()"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbPageStore } from "mongodb-rag-core";\n\nconst pageStore = makeMongoDbPageStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,t.jsx)(n.h2,{id:"embeddedcontentstore",children:(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})," is an interface to the stored content and vector\nembeddings used in your RAG app."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})," that stores data in MongoDB,\nyou can use the function ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#makemongodbembeddedcontentstore",children:(0,t.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"})}),".\nThis function returns an ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"}),". This ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})," persists data in the ",(0,t.jsx)(n.code,{children:"embedded_content"})," collection in MongoDB."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})," with ",(0,t.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbEmbeddedContentStore } from "mongodb-rag-core";\n\nconst embeddedContentStore = makeMongoDbEmbeddedContentStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,t.jsx)(n.admonition,{title:"Set up Atlas Vector Search",type:"important",children:(0,t.jsxs)(n.p,{children:["To use the ",(0,t.jsx)(n.code,{children:"EmbeddedContentStore"})," returned by ",(0,t.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"})," in your RAG app,\nyou must set up Atlas Vector Search on the ",(0,t.jsx)(n.code,{children:"embedded_content"})," collection in MongoDB.\nFor more information on setting up the vector search index on the ",(0,t.jsx)(n.code,{children:"embedded_content"})," collection,\nrefer to the ",(0,t.jsx)(n.a,{href:"/chatbot/mongodb#3-create-atlas-vector-search-index",children:"Create Atlas Vector Search Index"}),"\ndocumentation."]})}),"\n",(0,t.jsx)(n.h2,{id:"datasource",children:(0,t.jsx)(n.code,{children:"DataSource"})}),"\n",(0,t.jsx)(n.p,{children:"Add data sources for the Ingest CLI to pull content from."}),"\n",(0,t.jsxs)(n.p,{children:["Your ",(0,t.jsx)(n.a,{href:"../reference/ingest/modules/sources#datasource",children:(0,t.jsx)(n.code,{children:"DataSource"})})," implementations depend on where the content is coming from.\nTo learn more about creating a ",(0,t.jsx)(n.code,{children:"DataSource"}),", refer to the ",(0,t.jsx)(n.a,{href:"/chatbot/ingest/data-sources",children:"Data Sources"})," documentation."]}),"\n",(0,t.jsx)(n.h2,{id:"embedder",children:(0,t.jsx)(n.code,{children:"Embedder"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#embedder",children:(0,t.jsx)(n.code,{children:"Embedder"})})," takes in a string and returns a vector embedding for that string."]}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"Embedder"})," that uses the LangChain ",(0,t.jsx)(n.code,{children:"Embeddings"})," class,\nyou can use the function ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#makelangchainembedder",children:(0,t.jsx)(n.code,{children:"makeLangChainEmbedder()"})}),". To see the various embedding models supported by LangChain, refer to the ",(0,t.jsx)(n.a,{href:"https://js.langchain.com/docs/integrations/text_embedding",children:"LangChain text embedding models"})," documentation."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { makeLangChainEmbedder } from "mongodb-rag-core";\nimport { OpenAIEmbeddings } from "@langchain/openai";\n\nconst { OPENAI_API_KEY } = process.env;\n\nconst langChainOpenAiEmbeddings = new OpenAIEmbeddings({\n openAIApiKey: OPENAI_API_KEY,\n modelName: "text-embedding-3-large",\n dimensions: 1024,\n});\n\nconst embedder = makeLangChainEmbedder({\n langChainEmbeddings: langChainOpenAiEmbeddings,\n});\n'})}),"\n",(0,t.jsxs)(n.p,{children:["To create an ",(0,t.jsx)(n.code,{children:"Embedder"})," that uses the ",(0,t.jsx)(n.a,{href:"https://platform.openai.com/docs/guides/embeddings",children:"OpenAI Embeddings API"})," directly,\nyou can use the function ",(0,t.jsx)(n.a,{href:"/chatbot/reference/core/modules#makeopenaiembedder",children:(0,t.jsx)(n.code,{children:"makeOpenAiEmbedder()"})}),". This function uses the\n",(0,t.jsx)(n.code,{children:"@azure/openai"})," package to construct the OpenAI client, which supports\nboth the Azure OpenAI Service and the Open API."]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"makeOpenAiEmbedder()"})," function also supports configuring exponential backoff\nwith the ",(0,t.jsx)(n.code,{children:"backoffOptions"})," argument. This wraps the ",(0,t.jsx)(n.code,{children:"exponential-backoff"})," package.\nExponential backoff behavior is included because when you are bulk uploading embeddings for content, you\nmay hit the rate limit for the OpenAI Embeddings API. This allows you to\nautomatically retry the embedding request after a delay."]}),"\n",(0,t.jsx)(n.p,{children:"Example usage:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import {\n makeOpenAiEmbedder,\n OpenAIClient,\n AzureKeyCredential,\n} from "mongodb-rag-core";\nconst { OPENAI_ENDPOINT, OPENAI_API_KEY, OPENAI_EMBEDDING_DEPLOYMENT } =\n process.env;\n\nconst embedder = makeOpenAiEmbedder({\n openAiClient: new OpenAIClient(\n OPENAI_ENDPOINT,\n new AzureKeyCredential(OPENAI_API_KEY)\n ),\n deployment: OPENAI_EMBEDDING_DEPLOYMENT,\n backoffOptions: {\n numOfAttempts: 25,\n startingDelay: 1000,\n },\n});\n'})}),"\n",(0,t.jsx)(n.h2,{id:"chunkoptions",children:(0,t.jsx)(n.code,{children:"ChunkOptions"})}),"\n",(0,t.jsxs)(n.p,{children:["Use the ",(0,t.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,t.jsx)(n.code,{children:"ChunkOptions"})}),"\nto configure how the Ingest CLI chunks content when converting ",(0,t.jsx)(n.code,{children:"Page"})," documents\nto ",(0,t.jsx)(n.code,{children:"EmbeddedContent"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["By default, the Ingest CLI uses the following ",(0,t.jsx)(n.code,{children:"ChunkOptions"}),".\nThese should work for many RAG apps."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import GPT3Tokenizer from "gpt3-tokenizer";\n\nconst defaultMdChunkOptions: ChunkOptions = {\n maxChunkSize: 600, // max chunk size of 600 tokens gets avg ~400 tokens/chunk\n minChunkSize: 15, // chunks below this size are discarded, which improves search quality\n chunkOverlap: 0,\n tokenizer: new GPT3Tokenizer({ type: "gpt3" }),\n};\n'})}),"\n",(0,t.jsxs)(n.p,{children:["For more information on optimizing the ",(0,t.jsx)(n.code,{children:"ChunkOptions"}),", refer to ",(0,t.jsx)(n.a,{href:"/chatbot/ingest/optimize#refine-the-chunking-strategy",children:"Refine the Chunking Strategy"})," in the Optimization documentation."]})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},11151:(e,n,o)=>{o.d(n,{Z:()=>d,a:()=>i});var t=o(67294);const r={},c=t.createContext(r);function i(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/29c2c5fe.c97b09fb.js b/assets/js/29c2c5fe.c97b09fb.js
deleted file mode 100644
index bdc51315a..000000000
--- a/assets/js/29c2c5fe.c97b09fb.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8641],{44107:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>c,metadata:()=>s,toc:()=>a});var o=t(85893),r=t(11151);const c={},i="Configuration Reference",s={id:"ingest/configuration-reference",title:"Configuration Reference",description:"This page contains reference documentation for the configuration options for the MongoDB RAG Ingest CLI.",source:"@site/docs/ingest/configuration-reference.md",sourceDirName:"ingest",slug:"/ingest/configuration-reference",permalink:"/chatbot/ingest/configuration-reference",draft:!1,unlisted:!1,editUrl:"https://github.com/mongodb/chatbot/tree/main/docs/docs/ingest/configuration-reference.md",tags:[],version:"current",frontMatter:{},sidebar:"main",previous:{title:"Configure the Ingest CLI",permalink:"/chatbot/ingest/configure"},next:{title:"CLI Commands Reference",permalink:"/chatbot/ingest/command-reference"}},d={},a=[{value:"API Reference",id:"api-reference",level:2},{value:"Config",id:"config",level:2},{value:"IngestMetaStore",id:"ingestmetastore",level:2},{value:"PageStore",id:"pagestore",level:2},{value:"EmbeddedContentStore",id:"embeddedcontentstore",level:2},{value:"DataSource",id:"datasource",level:2},{value:"Embedder",id:"embedder",level:2},{value:"ChunkOptions",id:"chunkoptions",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"configuration-reference",children:"Configuration Reference"}),"\n",(0,o.jsx)(n.p,{children:"This page contains reference documentation for the configuration options for the MongoDB RAG Ingest CLI."}),"\n",(0,o.jsxs)(n.p,{children:["A Ingest CLI config files is a CommonJS file that exports a ",(0,o.jsx)(n.code,{children:"Config"})," object as its default export."]}),"\n",(0,o.jsxs)(n.p,{children:["For more information on setting up a configuration file, refer to the ",(0,o.jsx)(n.a,{href:"/chatbot/ingest/configure",children:"Configure"})," documentation."]}),"\n",(0,o.jsx)(n.p,{children:"To set up a configuration file, you must first install the following packages:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"npm install mongodb-rag-ingest mongodb-rag-core\n"})}),"\n",(0,o.jsx)(n.h2,{id:"api-reference",children:"API Reference"}),"\n",(0,o.jsxs)(n.p,{children:["For a full API reference of all modules exported by ",(0,o.jsx)(n.code,{children:"mongodb-rag-ingest"}),"\nand ",(0,o.jsx)(n.code,{children:"mongodb-rag-core"}),", refer to the ",(0,o.jsx)(n.a,{href:"../reference/",children:"API Reference"})," documentation."]}),"\n",(0,o.jsx)(n.p,{children:"This page links to the key reference documentation for configuring the Ingest CLI."}),"\n",(0,o.jsx)(n.h2,{id:"config",children:(0,o.jsx)(n.code,{children:"Config"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/#config",children:(0,o.jsx)(n.code,{children:"Config"})})," type is the root configuration type for the Ingest CLI."]}),"\n",(0,o.jsx)(n.h2,{id:"ingestmetastore",children:(0,o.jsx)(n.code,{children:"IngestMetaStore"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules#ingestmetastore",children:(0,o.jsx)(n.code,{children:"IngestMetaStore"})})," is an interface to interact with MongoDB collection that tracks metadata associated with the ingest process."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"IngestMetaStore"}),", you can use the function ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules#makeingestmetastore",children:(0,o.jsx)(n.code,{children:"makeIngestMetaStore()"})}),".\nThis function returns an ",(0,o.jsx)(n.code,{children:"IngestMetaStore"}),".\nThis ",(0,o.jsx)(n.code,{children:"IngestMetaStore"})," persists data in the ",(0,o.jsx)(n.code,{children:"ingest_meta"})," collection in MongoDB."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"IngestMetaStore"})," with ",(0,o.jsx)(n.code,{children:"makeIngestMetaStore()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeIngestMetaStore } from "mongodb-rag-ingest";\n\nconst ingestMetaStore = makeIngestMetaStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n entryId: "all",\n});\n'})}),"\n",(0,o.jsx)(n.h2,{id:"pagestore",children:(0,o.jsx)(n.code,{children:"PageStore"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#pagestore",children:(0,o.jsx)(n.code,{children:"PageStore"})})," is an interface\nto interact with ",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#page",children:(0,o.jsx)(n.code,{children:"Page"})})," data."]}),"\n",(0,o.jsxs)(n.p,{children:["To create a ",(0,o.jsx)(n.code,{children:"PageStore"})," that uses MongoDB to store pages, you can use the function\n",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#makemongodbpagestore",children:(0,o.jsx)(n.code,{children:"makeMongoDbPageStore()"})}),".\nThis function returns a ",(0,o.jsx)(n.code,{children:"PageStore"}),". This ",(0,o.jsx)(n.code,{children:"PageStore"})," persists data in the ",(0,o.jsx)(n.code,{children:"pages"})," collection in MongoDB."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"PageStore"})," with ",(0,o.jsx)(n.code,{children:"makeMongoDbPageStore()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbPageStore } from "mongodb-rag-core";\n\nconst pageStore = makeMongoDbPageStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,o.jsx)(n.h2,{id:"embeddedcontentstore",children:(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})," is an interface to the stored content and vector\nembeddings used in your RAG app."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})," that stores data in MongoDB,\nyou can use the function ",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#makemongodbembeddedcontentstore",children:(0,o.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"})}),".\nThis function returns an ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"}),". This ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})," persists data in the ",(0,o.jsx)(n.code,{children:"embedded_content"})," collection in MongoDB."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})," with ",(0,o.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbEmbeddedContentStore } from "mongodb-rag-core";\n\nconst embeddedContentStore = makeMongoDbEmbeddedContentStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,o.jsx)(n.admonition,{title:"Set up Atlas Vector Search",type:"important",children:(0,o.jsxs)(n.p,{children:["To use the ",(0,o.jsx)(n.code,{children:"EmbeddedContentStore"})," returned by ",(0,o.jsx)(n.code,{children:"makeMongoDbEmbeddedContentStore()"})," in your RAG app,\nyou must set up Atlas Vector Search on the ",(0,o.jsx)(n.code,{children:"embedded_content"})," collection in MongoDB.\nFor more information on setting up the vector search index on the ",(0,o.jsx)(n.code,{children:"embedded_content"})," collection,\nrefer to the ",(0,o.jsx)(n.a,{href:"/chatbot/mongodb#3-create-atlas-vector-search-index",children:"Create Atlas Vector Search Index"}),"\ndocumentation."]})}),"\n",(0,o.jsx)(n.h2,{id:"datasource",children:(0,o.jsx)(n.code,{children:"DataSource"})}),"\n",(0,o.jsx)(n.p,{children:"Add data sources for the Ingest CLI to pull content from."}),"\n",(0,o.jsxs)(n.p,{children:["Your ",(0,o.jsx)(n.a,{href:"../reference/ingest/modules/sources#datasource",children:(0,o.jsx)(n.code,{children:"DataSource"})})," implementations depend on where the content is coming from.\nTo learn more about creating a ",(0,o.jsx)(n.code,{children:"DataSource"}),", refer to the ",(0,o.jsx)(n.a,{href:"/chatbot/ingest/data-sources",children:"Data Sources"})," documentation."]}),"\n",(0,o.jsx)(n.h2,{id:"embedder",children:(0,o.jsx)(n.code,{children:"Embedder"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#embedder",children:(0,o.jsx)(n.code,{children:"Embedder"})})," takes in a string and returns a vector embedding for that string."]}),"\n",(0,o.jsxs)(n.p,{children:["To create an ",(0,o.jsx)(n.code,{children:"Embedder"})," that uses the ",(0,o.jsx)(n.a,{href:"https://platform.openai.com/docs/guides/embeddings",children:"OpenAI Embeddings API"}),",\nyou can use the function ",(0,o.jsx)(n.a,{href:"/chatbot/reference/core/modules#makeopenaiembedder",children:(0,o.jsx)(n.code,{children:"makeOpenAiEmbedder()"})}),". This function uses the\n",(0,o.jsx)(n.code,{children:"@azure/openai"})," package to construct the OpenAI client, which supports\nboth the Azure OpenAI Service and the Open API."]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"makeOpenAiEmbedder()"})," function also supports configuring exponential backoff\nwith the ",(0,o.jsx)(n.code,{children:"backoffOptions"})," argument. This wraps the ",(0,o.jsx)(n.code,{children:"exponential-backoff"})," package.\nExponential backoff behavior is included because when you are bulk uploading embeddings for content, you\nmay hit the rate limit for the OpenAI Embeddings API. This allows you to\nautomatically retry the embedding request after a delay."]}),"\n",(0,o.jsx)(n.p,{children:"Example usage:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {\n makeOpenAiEmbedder,\n OpenAIClient,\n AzureKeyCredential,\n} from "mongodb-rag-core";\nconst { OPENAI_ENDPOINT, OPENAI_API_KEY, OPENAI_EMBEDDING_DEPLOYMENT } =\n process.env;\n\nconst embedder = makeOpenAiEmbedder({\n openAiClient: new OpenAIClient(\n OPENAI_ENDPOINT,\n new AzureKeyCredential(OPENAI_API_KEY)\n ),\n deployment: OPENAI_EMBEDDING_DEPLOYMENT,\n backoffOptions: {\n numOfAttempts: 25,\n startingDelay: 1000,\n },\n});\n'})}),"\n",(0,o.jsx)(n.h2,{id:"chunkoptions",children:(0,o.jsx)(n.code,{children:"ChunkOptions"})}),"\n",(0,o.jsxs)(n.p,{children:["Use the ",(0,o.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,o.jsx)(n.code,{children:"ChunkOptions"})}),"\nto configure how the Ingest CLI chunks content when converting ",(0,o.jsx)(n.code,{children:"Page"})," documents\nto ",(0,o.jsx)(n.code,{children:"EmbeddedContent"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["By default, the Ingest CLI uses the following ",(0,o.jsx)(n.code,{children:"ChunkOptions"}),".\nThese should work for many RAG apps."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import GPT3Tokenizer from "gpt3-tokenizer";\n\nconst defaultMdChunkOptions: ChunkOptions = {\n maxChunkSize: 600, // max chunk size of 600 tokens gets avg ~400 tokens/chunk\n minChunkSize: 15, // chunks below this size are discarded, which improves search quality\n chunkOverlap: 0,\n tokenizer: new GPT3Tokenizer({ type: "gpt3" }),\n};\n'})}),"\n",(0,o.jsxs)(n.p,{children:["For more information on optimizing the ",(0,o.jsx)(n.code,{children:"ChunkOptions"}),", refer to ",(0,o.jsx)(n.a,{href:"/chatbot/ingest/optimize#refine-the-chunking-strategy",children:"Refine the Chunking Strategy"})," in the Optimization documentation."]})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var o=t(67294);const r={},c=o.createContext(r);function i(e){const n=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/2a14c161.3c02a64f.js b/assets/js/2a14c161.63e72a38.js
similarity index 89%
rename from assets/js/2a14c161.3c02a64f.js
rename to assets/js/2a14c161.63e72a38.js
index d70b94012..3a1222108 100644
--- a/assets/js/2a14c161.3c02a64f.js
+++ b/assets/js/2a14c161.63e72a38.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9344],{79787:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var o=t(85893),r=t(11151);const a={id:"MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",sidebar_label:"MakeMongoDbReportStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbReportStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbReportStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",sidebar_label:"MakeMongoDbReportStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeMongoDbGeneratedDataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams"},next:{title:"MongoDbEvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"collectionName",id:"collectionname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"connectionUri",id:"connectionuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"databaseName",id:"databasename",level:3},{value:"Defined in",id:"defined-in-2",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,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.code,{children:"Optional"})," ",(0,o.jsx)(n.strong,{children:"collectionName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Default"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"reports"\n'})}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L32",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:32"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"connectionUri"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L27",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:27"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"databasename",children:"databaseName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"databaseName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:28"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var o=t(67294);const r={},a=o.createContext(r);function i(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9344],{79787:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var o=t(85893),r=t(11151);const a={id:"MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",sidebar_label:"MakeMongoDbReportStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbReportStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbReportStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbReportStoreParams",title:"Interface: MakeMongoDbReportStoreParams",sidebar_label:"MakeMongoDbReportStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeMongoDbGeneratedDataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams"},next:{title:"MongoDbEvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"collectionName",id:"collectionname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"connectionUri",id:"connectionuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"databaseName",id:"databasename",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,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.code,{children:"Optional"})," ",(0,o.jsx)(n.strong,{children:"collectionName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"Default"})})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'"reports"\n'})}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L32",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:32"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"connectionUri"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L27",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:27"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"databasename",children:"databaseName"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"databaseName"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/report/ReportStore.ts:28"})})]})}function p(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:()=>s,a:()=>i});var o=t(67294);const r={},a=o.createContext(r);function i(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/34ee439d.ac1c79c1.js b/assets/js/34ee439d.ee0207a1.js
similarity index 95%
rename from assets/js/34ee439d.ac1c79c1.js
rename to assets/js/34ee439d.ee0207a1.js
index 77703fd4c..b14c22860 100644
--- a/assets/js/34ee439d.ac1c79c1.js
+++ b/assets/js/34ee439d.ee0207a1.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9868],{23367:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=a(85893),r=a(11151);const o={id:"MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",sidebar_label:"MakeMongoDbGeneratedDataStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",sidebar_label:"MakeMongoDbGeneratedDataStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeMongoDbEvaluationStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams"},next:{title:"MakeMongoDbReportStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"collectionName",id:"collectionname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"connectionUri",id:"connectionuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"databaseName",id:"databasename",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,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"collectionName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"Default"})})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'"generated_data"\n'})}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L55",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:55"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"connectionUri"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L49",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:49"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"databasename",children:"databaseName"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"databaseName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L50",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:50"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},11151:(e,n,a)=>{a.d(n,{Z:()=>s,a:()=>i});var t=a(67294);const r={},o=t.createContext(r);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9868],{23367:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=a(85893),r=a(11151);const o={id:"MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",sidebar_label:"MakeMongoDbGeneratedDataStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbGeneratedDataStoreParams",title:"Interface: MakeMongoDbGeneratedDataStoreParams",sidebar_label:"MakeMongoDbGeneratedDataStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeMongoDbEvaluationStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams"},next:{title:"MakeMongoDbReportStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"collectionName",id:"collectionname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"connectionUri",id:"connectionuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"databaseName",id:"databasename",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,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"collectionName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"Default"})})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'"generated_data"\n'})}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L55",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:55"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"connectionUri"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L49",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:49"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"databasename",children:"databaseName"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"databaseName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L50",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:50"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},11151:(e,n,a)=>{a.d(n,{Z:()=>s,a:()=>i});var t=a(67294);const r={},o=t.createContext(r);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/37f76691.2d0a8ede.js b/assets/js/37f76691.c5146136.js
similarity index 96%
rename from assets/js/37f76691.2d0a8ede.js
rename to assets/js/37f76691.c5146136.js
index 37ca06d4f..48fce734b 100644
--- a/assets/js/37f76691.2d0a8ede.js
+++ b/assets/js/37f76691.c5146136.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2357],{36128:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var a=t(85893),i=t(11151);const o={id:"EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",sidebar_label:"EvaluateConversationQualityParams",sidebar_position:0,custom_edit_url:null},s=void 0,r={id:"reference/evaluation/interfaces/EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/EvaluateConversationQualityParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",sidebar_label:"EvaluateConversationQualityParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvalResult",permalink:"/chatbot/reference/evaluation/interfaces/EvalResult"},next:{title:"EvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/EvaluationStore"}},l={},c=[{value:"Properties",id:"properties",level:2},{value:"deploymentName",id:"deploymentname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fewShotExamples",id:"fewshotexamples",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openAiClient",id:"openaiclient",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"deploymentname",children:"deploymentName"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"deploymentName"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"The name of the OpenAI ChatGPT API deployment to use."}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"Example"})})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'"gpt-3.5-turbo"\n'})}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L19",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:19"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"fewshotexamples",children:"fewShotExamples"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"fewShotExamples"}),": ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/ResponseQualityExample",children:(0,a.jsx)(n.code,{children:"ResponseQualityExample"})}),"[]"]}),"\n",(0,a.jsxs)(n.p,{children:["Provide a few examples of conversation transcripts, expected outputs,\nand what the LLM output should be.\nThis is ",(0,a.jsx)(n.em,{children:"extremely"})," useful for helping the LLM understand\nits expected behavior for your use case.\nWhile not strictly necessary, it is highly recommended\nto include a few representative examples."]}),"\n",(0,a.jsxs)(n.p,{children:["Here, the LLM utilizes a prompting technique called ",(0,a.jsx)(n.a,{href:"https://www.promptingguide.ai/techniques/fewshot.en",children:'"few-shot prompting"'}),"."]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L31",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:31"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"openaiclient",children:"openAiClient"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"openAiClient"}),": ",(0,a.jsx)(n.code,{children:"OpenAIClient"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L13",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:13"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>s});var a=t(67294);const i={},o=a.createContext(i);function s(e){const n=a.useContext(o);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2357],{36128:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var a=t(85893),i=t(11151);const o={id:"EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",sidebar_label:"EvaluateConversationQualityParams",sidebar_position:0,custom_edit_url:null},s=void 0,r={id:"reference/evaluation/interfaces/EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/EvaluateConversationQualityParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvaluateConversationQualityParams",title:"Interface: EvaluateConversationQualityParams",sidebar_label:"EvaluateConversationQualityParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvalResult",permalink:"/chatbot/reference/evaluation/interfaces/EvalResult"},next:{title:"EvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/EvaluationStore"}},l={},c=[{value:"Properties",id:"properties",level:2},{value:"deploymentName",id:"deploymentname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fewShotExamples",id:"fewshotexamples",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openAiClient",id:"openaiclient",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"deploymentname",children:"deploymentName"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"deploymentName"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"The name of the OpenAI ChatGPT API deployment to use."}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"Example"})})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'"gpt-3.5-turbo"\n'})}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L19",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:19"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"fewshotexamples",children:"fewShotExamples"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"fewShotExamples"}),": ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/ResponseQualityExample",children:(0,a.jsx)(n.code,{children:"ResponseQualityExample"})}),"[]"]}),"\n",(0,a.jsxs)(n.p,{children:["Provide a few examples of conversation transcripts, expected outputs,\nand what the LLM output should be.\nThis is ",(0,a.jsx)(n.em,{children:"extremely"})," useful for helping the LLM understand\nits expected behavior for your use case.\nWhile not strictly necessary, it is highly recommended\nto include a few representative examples."]}),"\n",(0,a.jsxs)(n.p,{children:["Here, the LLM utilizes a prompting technique called ",(0,a.jsx)(n.a,{href:"https://www.promptingguide.ai/techniques/fewshot.en",children:'"few-shot prompting"'}),"."]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L31",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:31"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"openaiclient",children:"openAiClient"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"openAiClient"}),": ",(0,a.jsx)(n.code,{children:"OpenAIClient"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts#L13",children:"packages/mongodb-chatbot-evaluation/src/evaluate/evaluateConversationQuality.ts:13"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>s});var a=t(67294);const i={},o=a.createContext(i);function s(e){const n=a.useContext(o);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/3f30df8d.c22126d4.js b/assets/js/3f30df8d.c22126d4.js
new file mode 100644
index 000000000..219ab71d3
--- /dev/null
+++ b/assets/js/3f30df8d.c22126d4.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9991],{79583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>s});var a=t(85893),i=t(11151);const d={id:"EvalResult",title:"Interface: EvalResult",sidebar_label:"EvalResult",sidebar_position:0,custom_edit_url:null},l=void 0,o={id:"reference/evaluation/interfaces/EvalResult",title:"Interface: EvalResult",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/EvalResult.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvalResult",permalink:"/chatbot/reference/evaluation/interfaces/EvalResult",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvalResult",title:"Interface: EvalResult",sidebar_label:"EvalResult",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvalConfig",permalink:"/chatbot/reference/evaluation/interfaces/EvalConfig"},next:{title:"EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams"}},r={},s=[{value:"Properties",id:"properties",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"commandRunMetadataId",id:"commandrunmetadataid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"createdAt",id:"createdat",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"generatedDataId",id:"generateddataid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"_id",children:"_id"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"_id"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L10",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:10"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"commandrunmetadataid",children:"commandRunMetadataId"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"commandRunMetadataId"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L12",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:12"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"createdat",children:"createdAt"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"createdAt"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:23"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"generateddataid",children:"generatedDataId"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"generatedDataId"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L11",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:11"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"metadata"}),": ",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:24"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"result",children:"result"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"result"}),": ",(0,a.jsx)(n.code,{children:"number"})]}),"\n",(0,a.jsx)(n.p,{children:"Number between 0 and 1, inclusive."}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L22",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:22"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"Name of the type of evaluation."}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L17",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:17"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>l});var a=t(67294);const i={},d=a.createContext(i);function l(e){const n=a.useContext(d);return a.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(i):e.components||i:l(e.components),a.createElement(d.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/3f30df8d.e8c2b570.js b/assets/js/3f30df8d.e8c2b570.js
deleted file mode 100644
index d7d55b569..000000000
--- a/assets/js/3f30df8d.e8c2b570.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9991],{79583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>s});var a=t(85893),i=t(11151);const d={id:"EvalResult",title:"Interface: EvalResult",sidebar_label:"EvalResult",sidebar_position:0,custom_edit_url:null},l=void 0,o={id:"reference/evaluation/interfaces/EvalResult",title:"Interface: EvalResult",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/EvalResult.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvalResult",permalink:"/chatbot/reference/evaluation/interfaces/EvalResult",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvalResult",title:"Interface: EvalResult",sidebar_label:"EvalResult",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvalConfig",permalink:"/chatbot/reference/evaluation/interfaces/EvalConfig"},next:{title:"EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams"}},r={},s=[{value:"Properties",id:"properties",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"commandRunMetadataId",id:"commandrunmetadataid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"createdAt",id:"createdat",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"evalName",id:"evalname",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"generatedDataId",id:"generateddataid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"_id",children:"_id"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"_id"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L10",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:10"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"commandrunmetadataid",children:"commandRunMetadataId"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"commandRunMetadataId"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L12",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:12"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"createdat",children:"createdAt"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"createdAt"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L18",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:18"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"evalname",children:"evalName"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"evalName"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L13",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:13"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"generateddataid",children:"generatedDataId"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"generatedDataId"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L11",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:11"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"metadata",children:"metadata"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"metadata"}),": ",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L19",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:19"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"result",children:"result"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"result"}),": ",(0,a.jsx)(n.code,{children:"number"})]}),"\n",(0,a.jsx)(n.p,{children:"Number between 0 and 1, inclusive."}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L17",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:17"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>l});var a=t(67294);const i={},d=a.createContext(i);function l(e){const n=a.useContext(d);return a.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(i):e.components||i:l(e.components),a.createElement(d.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/44c3951e.5f54fedf.js b/assets/js/44c3951e.e3575809.js
similarity index 94%
rename from assets/js/44c3951e.5f54fedf.js
rename to assets/js/44c3951e.e3575809.js
index 4e27ab616..da7e9e1ef 100644
--- a/assets/js/44c3951e.5f54fedf.js
+++ b/assets/js/44c3951e.e3575809.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4125],{25659:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=n(85893),a=n(11151);const i={id:"CheckResponseQuality",title:"Interface: CheckResponseQuality",sidebar_label:"CheckResponseQuality",sidebar_position:0,custom_edit_url:null},o=void 0,r={id:"reference/evaluation/interfaces/CheckResponseQuality",title:"Interface: CheckResponseQuality",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/CheckResponseQuality.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CheckResponseQuality",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQuality",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CheckResponseQuality",title:"Interface: CheckResponseQuality",sidebar_label:"CheckResponseQuality",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"BaseTestCase",permalink:"/chatbot/reference/evaluation/interfaces/BaseTestCase"},next:{title:"CheckResponseQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"meetsChatQualityStandards",id:"meetschatqualitystandards",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"reason",id:"reason",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"meetschatqualitystandards",children:"meetsChatQualityStandards"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"meetsChatQualityStandards"}),": ",(0,s.jsx)(t.code,{children:"boolean"})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts:24"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"reason",children:"reason"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"reason"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts:23"})})]})}function u(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(67294);const a={},i=s.createContext(a);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4125],{25659:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=n(85893),a=n(11151);const i={id:"CheckResponseQuality",title:"Interface: CheckResponseQuality",sidebar_label:"CheckResponseQuality",sidebar_position:0,custom_edit_url:null},o=void 0,r={id:"reference/evaluation/interfaces/CheckResponseQuality",title:"Interface: CheckResponseQuality",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/CheckResponseQuality.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CheckResponseQuality",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQuality",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CheckResponseQuality",title:"Interface: CheckResponseQuality",sidebar_label:"CheckResponseQuality",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"BaseTestCase",permalink:"/chatbot/reference/evaluation/interfaces/BaseTestCase"},next:{title:"CheckResponseQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"meetsChatQualityStandards",id:"meetschatqualitystandards",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"reason",id:"reason",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"meetschatqualitystandards",children:"meetsChatQualityStandards"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"meetsChatQualityStandards"}),": ",(0,s.jsx)(t.code,{children:"boolean"})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts:24"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"reason",children:"reason"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"reason"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/evaluate/checkResponseQuality.ts:23"})})]})}function u(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(67294);const a={},i=s.createContext(a);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/46ba77e2.494cb713.js b/assets/js/46ba77e2.93817308.js
similarity index 96%
rename from assets/js/46ba77e2.494cb713.js
rename to assets/js/46ba77e2.93817308.js
index ea1ee23f8..221303b3a 100644
--- a/assets/js/46ba77e2.494cb713.js
+++ b/assets/js/46ba77e2.93817308.js
@@ -1 +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/7463475/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/7463475/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/7463475/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
+"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/f43cc5d/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/f43cc5d/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/f43cc5d/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.0d05c5ff.js b/assets/js/47301a5f.57f6d2a5.js
similarity index 81%
rename from assets/js/47301a5f.0d05c5ff.js
rename to assets/js/47301a5f.57f6d2a5.js
index 8d5113a00..4b760f917 100644
--- a/assets/js/47301a5f.0d05c5ff.js
+++ b/assets/js/47301a5f.57f6d2a5.js
@@ -1 +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:()=>l});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={},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,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/7463475/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/7463475/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/7463475/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/7463475/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)(d,{...e})}):d(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
+"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:()=>d});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={},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,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/mongodben/chatbot/blob/f43cc5d/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/f43cc5d/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/f43cc5d/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/f43cc5d/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)(l,{...e})}):l(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/4c053673.20be928e.js b/assets/js/4c053673.9515590f.js
similarity index 89%
rename from assets/js/4c053673.20be928e.js
rename to assets/js/4c053673.9515590f.js
index eb114ba46..86ea0ce98 100644
--- a/assets/js/4c053673.20be928e.js
+++ b/assets/js/4c053673.9515590f.js
@@ -1 +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/7463475/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/7463475/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/7463475/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/7463475/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/7463475/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
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8753],{68367:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});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"}},d={},a=[{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/f43cc5d/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/f43cc5d/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/f43cc5d/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/f43cc5d/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/f43cc5d/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/4e9b4fcd.57b5eb80.js b/assets/js/4e9b4fcd.aba723b1.js
similarity index 94%
rename from assets/js/4e9b4fcd.57b5eb80.js
rename to assets/js/4e9b4fcd.aba723b1.js
index 6dbeeb483..9d168f0bc 100644
--- a/assets/js/4e9b4fcd.57b5eb80.js
+++ b/assets/js/4e9b4fcd.aba723b1.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5302],{17594:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>h,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:"staticResponse",id:"staticresponse",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"userMessage",id:"usermessage",level:3},{value:"Defined in",id:"defined-in-3",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/7463475/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L53",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:53"})}),"\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:["If true, no response should be generated with an LLM. Instead, return the\n",(0,s.jsx)(r.code,{children:"staticResponse"})," if set or otherwise respond with a standard static\nrejection response."]}),"\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/7463475/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:"staticresponse",children:"staticResponse"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"staticResponse"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#assistantmessage",children:(0,s.jsx)(r.code,{children:"AssistantMessage"})})]}),"\n",(0,s.jsx)(r.p,{children:"If defined, this message should be sent as a response instead of generating\na response to the user query with the LLM."}),"\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/7463475/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.p,{children:"The (preprocessed) user message to insert into the conversation."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L48",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:48"})})]})}function h(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
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5302],{17594:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>h,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:"staticResponse",id:"staticresponse",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"userMessage",id:"usermessage",level:3},{value:"Defined in",id:"defined-in-3",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/f43cc5d/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L53",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:53"})}),"\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:["If true, no response should be generated with an LLM. Instead, return the\n",(0,s.jsx)(r.code,{children:"staticResponse"})," if set or otherwise respond with a standard static\nrejection response."]}),"\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/f43cc5d/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:"staticresponse",children:"staticResponse"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"staticResponse"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#assistantmessage",children:(0,s.jsx)(r.code,{children:"AssistantMessage"})})]}),"\n",(0,s.jsx)(r.p,{children:"If defined, this message should be sent as a response instead of generating\na response to the user query with the LLM."}),"\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/f43cc5d/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.p,{children:"The (preprocessed) user message to insert into the conversation."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts#L48",children:"packages/mongodb-chatbot-server/src/processors/GenerateUserPromptFunc.ts:48"})})]})}function h(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/4fddc917.30f6d16f.js b/assets/js/4fddc917.a24c6ed5.js
similarity index 91%
rename from assets/js/4fddc917.30f6d16f.js
rename to assets/js/4fddc917.a24c6ed5.js
index 608a30ef5..069b2c358 100644
--- a/assets/js/4fddc917.30f6d16f.js
+++ b/assets/js/4fddc917.a24c6ed5.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2477],{12766:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>l});var a=n(85893),d=n(11151);const r={id:"CommandMetadataStore",title:"Interface: CommandMetadataStore",sidebar_label:"CommandMetadataStore",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/CommandMetadataStore",title:"Interface: CommandMetadataStore",description:"Methods",source:"@site/docs/reference/evaluation/interfaces/CommandMetadataStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CommandMetadataStore",permalink:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandMetadataStore",title:"Interface: CommandMetadataStore",sidebar_label:"CommandMetadataStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CheckResponseQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams"},next:{title:"CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata"}},o={},l=[{value:"Methods",id:"methods",level:2},{value:"close",id:"close",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"findById",id:"findbyid",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function c(e){const t={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,d.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,a.jsx)(t.h3,{id:"close",children:"close"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"close"}),"(): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L13",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:13"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"findbyid",children:"findById"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"findById"}),"(",(0,a.jsx)(t.code,{children:"commandId"}),"): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"undefined"})," | ",(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"commandId"})}),(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"ObjectId"})})]})})]}),"\n",(0,a.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"undefined"})," | ",(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L12",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:12"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"insertone",children:"insertOne"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"insertOne"}),"(",(0,a.jsx)(t.code,{children:"command"}),"): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"boolean"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"command"})}),(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})})})]})})]}),"\n",(0,a.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"boolean"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L11",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:11"})})]})}function h(e={}){const{wrapper:t}={...(0,d.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var a=n(67294);const d={},r=a.createContext(d);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2477],{12766:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(85893),d=n(11151);const r={id:"CommandMetadataStore",title:"Interface: CommandMetadataStore",sidebar_label:"CommandMetadataStore",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/CommandMetadataStore",title:"Interface: CommandMetadataStore",description:"Methods",source:"@site/docs/reference/evaluation/interfaces/CommandMetadataStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CommandMetadataStore",permalink:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandMetadataStore",title:"Interface: CommandMetadataStore",sidebar_label:"CommandMetadataStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CheckResponseQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams"},next:{title:"CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata"}},o={},c=[{value:"Methods",id:"methods",level:2},{value:"close",id:"close",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"findById",id:"findbyid",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const t={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,d.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,a.jsx)(t.h3,{id:"close",children:"close"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"close"}),"(): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L13",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:13"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"findbyid",children:"findById"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"findById"}),"(",(0,a.jsx)(t.code,{children:"commandId"}),"): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"undefined"})," | ",(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"commandId"})}),(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"ObjectId"})})]})})]}),"\n",(0,a.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"undefined"})," | ",(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L12",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:12"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"insertone",children:"insertOne"}),"\n",(0,a.jsxs)(t.p,{children:["\u25b8 ",(0,a.jsx)(t.strong,{children:"insertOne"}),"(",(0,a.jsx)(t.code,{children:"command"}),"): ",(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"boolean"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,a.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.code,{children:"command"})}),(0,a.jsx)(t.td,{style:{textAlign:"left"},children:(0,a.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",children:(0,a.jsx)(t.code,{children:"CommandRunMetadata"})})})]})})]}),"\n",(0,a.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Promise"}),"<",(0,a.jsx)(t.code,{children:"boolean"}),">"]}),"\n",(0,a.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L11",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:11"})})]})}function h(e={}){const{wrapper:t}={...(0,d.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var a=n(67294);const d={},r=a.createContext(d);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/522e53fb.a21a39eb.js b/assets/js/522e53fb.69b73fc2.js
similarity index 97%
rename from assets/js/522e53fb.a21a39eb.js
rename to assets/js/522e53fb.69b73fc2.js
index ae56bead6..235d7c834 100644
--- a/assets/js/522e53fb.a21a39eb.js
+++ b/assets/js/522e53fb.69b73fc2.js
@@ -1 +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/7463475/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/7463475/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
+"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/f43cc5d/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/f43cc5d/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/52cccada.c4eaa55c.js b/assets/js/52cccada.28146a12.js
similarity index 95%
rename from assets/js/52cccada.c4eaa55c.js
rename to assets/js/52cccada.28146a12.js
index 4d67343c4..e1d7a0078 100644
--- a/assets/js/52cccada.c4eaa55c.js
+++ b/assets/js/52cccada.28146a12.js
@@ -1 +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/7463475/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L49",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:49"})}),"\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/7463475/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L61",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:61"})}),"\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/7463475/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L42",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:42"})}),"\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/7463475/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L54",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:54"})})]})}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
+"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/f43cc5d/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L49",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:49"})}),"\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/f43cc5d/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L61",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:61"})}),"\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/f43cc5d/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L42",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:42"})}),"\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/f43cc5d/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L54",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:54"})})]})}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/59c4025c.6713d7ca.js b/assets/js/59c4025c.c3660405.js
similarity index 89%
rename from assets/js/59c4025c.6713d7ca.js
rename to assets/js/59c4025c.c3660405.js
index 89250463d..9c3300ad1 100644
--- a/assets/js/59c4025c.6713d7ca.js
+++ b/assets/js/59c4025c.c3660405.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5299],{45109:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var a=t(85893),d=t(11151);const i={id:"CommandRunMetadata",title:"Interface: CommandRunMetadata",sidebar_label:"CommandRunMetadata",sidebar_position:0,custom_edit_url:null},o=void 0,r={id:"reference/evaluation/interfaces/CommandRunMetadata",title:"Interface: CommandRunMetadata",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/CommandRunMetadata.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandRunMetadata",title:"Interface: CommandRunMetadata",sidebar_label:"CommandRunMetadata",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CommandMetadataStore",permalink:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore"},next:{title:"ConversationEvalData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationEvalData"}},s={},c=[{value:"Properties",id:"properties",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"endTime",id:"endtime",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:"startTime",id:"starttime",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,d.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"_id",children:"_id"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"_id"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L4",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:4"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"command"}),": ",(0,a.jsx)(n.code,{children:'"generate"'})," | ",(0,a.jsx)(n.code,{children:'"evaluate"'})," | ",(0,a.jsx)(n.code,{children:'"report"'})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L5",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:5"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"endtime",children:"endTime"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"endTime"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L8",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:8"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"name"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L6",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:6"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"starttime",children:"startTime"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"startTime"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L7",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:7"})})]})}function m(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var a=t(67294);const d={},i=a.createContext(d);function o(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:o(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5299],{45109:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>r,toc:()=>s});var a=t(85893),d=t(11151);const i={id:"CommandRunMetadata",title:"Interface: CommandRunMetadata",sidebar_label:"CommandRunMetadata",sidebar_position:0,custom_edit_url:null},o=void 0,r={id:"reference/evaluation/interfaces/CommandRunMetadata",title:"Interface: CommandRunMetadata",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/CommandRunMetadata.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandRunMetadata",title:"Interface: CommandRunMetadata",sidebar_label:"CommandRunMetadata",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CommandMetadataStore",permalink:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore"},next:{title:"ConversationEvalData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationEvalData"}},c={},s=[{value:"Properties",id:"properties",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"endTime",id:"endtime",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:"startTime",id:"starttime",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,d.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"_id",children:"_id"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"_id"}),": ",(0,a.jsx)(n.code,{children:"ObjectId"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L4",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:4"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"command"}),": ",(0,a.jsx)(n.code,{children:'"generate"'})," | ",(0,a.jsx)(n.code,{children:'"evaluate"'})," | ",(0,a.jsx)(n.code,{children:'"report"'})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L5",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:5"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"endtime",children:"endTime"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"endTime"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L8",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:8"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"name"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L6",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:6"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"starttime",children:"startTime"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"startTime"}),": ",(0,a.jsx)(n.code,{children:"Date"})]}),"\n",(0,a.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L7",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:7"})})]})}function m(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var a=t(67294);const d={},i=a.createContext(d);function o(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:o(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/6b7a1cdb.fba802b2.js b/assets/js/6b7a1cdb.7f07114b.js
similarity index 96%
rename from assets/js/6b7a1cdb.fba802b2.js
rename to assets/js/6b7a1cdb.7f07114b.js
index e66bd7c7f..91d138cb5 100644
--- a/assets/js/6b7a1cdb.fba802b2.js
+++ b/assets/js/6b7a1cdb.7f07114b.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3820],{4578:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var s=n(85893),i=n(11151);const t={id:"MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",sidebar_label:"MakeVerifiedAnswerGenerateUserPromptParams",sidebar_position:0,custom_edit_url:null},a=void 0,o={id:"reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",description:"Properties",source:"@site/docs/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",permalink:"/chatbot/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",sidebar_label:"MakeVerifiedAnswerGenerateUserPromptParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeUserMessageFuncParams",permalink:"/chatbot/reference/server/interfaces/MakeUserMessageFuncParams"},next:{title:"OpenAiChatMessage",permalink:"/chatbot/reference/server/interfaces/OpenAiChatMessage"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"findVerifiedAnswer",id:"findverifiedanswer",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onNoVerifiedAnswerFound",id:"onnoverifiedanswerfound",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function f(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.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:"findverifiedanswer",children:"findVerifiedAnswer"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"findVerifiedAnswer"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#findverifiedanswerfunc",children:(0,s.jsx)(r.code,{children:"FindVerifiedAnswerFunc"})})]}),"\n",(0,s.jsx)(r.p,{children:"Find content based on the user's message and preprocessing."}),"\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/7463475/packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts#L11",children:"packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts:11"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"onnoverifiedanswerfound",children:"onNoVerifiedAnswerFound"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"onNoVerifiedAnswerFound"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,s.jsx)(r.code,{children:"GenerateUserPromptFunc"})})]}),"\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/7463475/packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts#L13",children:"packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts:13"})})]})}function l(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},11151:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>a});var s=n(67294);const i={},t=s.createContext(i);function a(e){const r=s.useContext(t);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(i):e.components||i:a(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3820],{4578:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var s=n(85893),i=n(11151);const t={id:"MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",sidebar_label:"MakeVerifiedAnswerGenerateUserPromptParams",sidebar_position:0,custom_edit_url:null},a=void 0,o={id:"reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",description:"Properties",source:"@site/docs/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",permalink:"/chatbot/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeVerifiedAnswerGenerateUserPromptParams",title:"Interface: MakeVerifiedAnswerGenerateUserPromptParams",sidebar_label:"MakeVerifiedAnswerGenerateUserPromptParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeUserMessageFuncParams",permalink:"/chatbot/reference/server/interfaces/MakeUserMessageFuncParams"},next:{title:"OpenAiChatMessage",permalink:"/chatbot/reference/server/interfaces/OpenAiChatMessage"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"findVerifiedAnswer",id:"findverifiedanswer",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onNoVerifiedAnswerFound",id:"onnoverifiedanswerfound",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function f(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.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:"findverifiedanswer",children:"findVerifiedAnswer"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"findVerifiedAnswer"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#findverifiedanswerfunc",children:(0,s.jsx)(r.code,{children:"FindVerifiedAnswerFunc"})})]}),"\n",(0,s.jsx)(r.p,{children:"Find content based on the user's message and preprocessing."}),"\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/f43cc5d/packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts#L11",children:"packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts:11"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"onnoverifiedanswerfound",children:"onNoVerifiedAnswerFound"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"onNoVerifiedAnswerFound"}),": ",(0,s.jsx)(r.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,s.jsx)(r.code,{children:"GenerateUserPromptFunc"})})]}),"\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/f43cc5d/packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts#L13",children:"packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts:13"})})]})}function l(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},11151:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>a});var s=n(67294);const i={},t=s.createContext(i);function a(e){const r=s.useContext(t);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(i):e.components||i:a(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/6c0ba004.a9142b07.js b/assets/js/6c0ba004.1a8d453c.js
similarity index 89%
rename from assets/js/6c0ba004.a9142b07.js
rename to assets/js/6c0ba004.1a8d453c.js
index d5f94f841..278f1276b 100644
--- a/assets/js/6c0ba004.a9142b07.js
+++ b/assets/js/6c0ba004.1a8d453c.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3519],{80461:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var l=t(85893),r=t(11151);const i={id:"EvaluationStore",title:"Interface: EvaluationStore",sidebar_label:"EvaluationStore",sidebar_position:0,custom_edit_url:null},s=void 0,a={id:"reference/evaluation/interfaces/EvaluationStore",title:"Interface: EvaluationStore",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/EvaluationStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/EvaluationStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvaluationStore",title:"Interface: EvaluationStore",sidebar_label:"EvaluationStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams"},next:{title:"GenerateDataAndMetadataParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams"}},d={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Methods",id:"methods",level:2},{value:"aggregate",id:"aggregate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"close",id:"close",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"find",id:"find",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"insertMany",id:"insertmany",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"EvaluationStore"})})}),"\n",(0,l.jsxs)(n.p,{children:["\u21b3 ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore",children:(0,l.jsx)(n.code,{children:"MongoDbEvaluationStore"})})]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,l.jsx)(n.h3,{id:"aggregate",children:"aggregate"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"aggregate"}),"(",(0,l.jsx)(n.code,{children:"pipeline"}),", ",(0,l.jsx)(n.code,{children:"options?"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"Document"}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"pipeline"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"unknown"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"options?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"unknown"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"Document"}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L26",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:26"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"close",children:"close"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"close"}),"(): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L27",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:27"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"find",children:"find"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"find"}),"(",(0,l.jsx)(n.code,{children:"filter"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"filter"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"unknown"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L25",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:25"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"insertmany",children:"insertMany"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"insertMany"}),"(",(0,l.jsx)(n.code,{children:"evalResults"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"evalResults"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:24"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"insertone",children:"insertOne"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"insertOne"}),"(",(0,l.jsx)(n.code,{children:"evalResult"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"evalResult"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/7463475/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:23"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var l=t(67294);const r={},i=l.createContext(r);function s(e){const n=l.useContext(i);return l.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:s(e.components),l.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3519],{80461:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var l=t(85893),r=t(11151);const i={id:"EvaluationStore",title:"Interface: EvaluationStore",sidebar_label:"EvaluationStore",sidebar_position:0,custom_edit_url:null},s=void 0,a={id:"reference/evaluation/interfaces/EvaluationStore",title:"Interface: EvaluationStore",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/EvaluationStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/EvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/EvaluationStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EvaluationStore",title:"Interface: EvaluationStore",sidebar_label:"EvaluationStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvaluateConversationQualityParams",permalink:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams"},next:{title:"GenerateDataAndMetadataParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams"}},d={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Methods",id:"methods",level:2},{value:"aggregate",id:"aggregate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"close",id:"close",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"find",id:"find",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"insertMany",id:"insertmany",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"EvaluationStore"})})}),"\n",(0,l.jsxs)(n.p,{children:["\u21b3 ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore",children:(0,l.jsx)(n.code,{children:"MongoDbEvaluationStore"})})]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,l.jsx)(n.h3,{id:"aggregate",children:"aggregate"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"aggregate"}),"(",(0,l.jsx)(n.code,{children:"pipeline"}),", ",(0,l.jsx)(n.code,{children:"options?"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"Document"}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"pipeline"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"unknown"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"options?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"unknown"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"Document"}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L31",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:31"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"close",children:"close"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"close"}),"(): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L32",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:32"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"find",children:"find"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"find"}),"(",(0,l.jsx)(n.code,{children:"filter"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"filter"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"unknown"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]>"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L30",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:30"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"insertmany",children:"insertMany"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"insertMany"}),"(",(0,l.jsx)(n.code,{children:"evalResults"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"evalResults"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})}),"[]"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:29"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"insertone",children:"insertOne"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"insertOne"}),"(",(0,l.jsx)(n.code,{children:"evalResult"}),"): ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"evalResult"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalResult",children:(0,l.jsx)(n.code,{children:"EvalResult"})})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/evaluate/EvaluationStore.ts:28"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var l=t(67294);const r={},i=l.createContext(r);function s(e){const n=l.useContext(i);return l.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:s(e.components),l.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/770044b3.1415a954.js b/assets/js/770044b3.7df59b3e.js
similarity index 84%
rename from assets/js/770044b3.1415a954.js
rename to assets/js/770044b3.7df59b3e.js
index 068e215e6..79086f09e 100644
--- a/assets/js/770044b3.1415a954.js
+++ b/assets/js/770044b3.7df59b3e.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5658],{55939:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=a(85893),r=a(11151);const s={id:"MakeGenerateConversationDataParams",title:"Interface: MakeGenerateConversationDataParams",sidebar_label:"MakeGenerateConversationDataParams",sidebar_position:0,custom_edit_url:null},i=void 0,o={id:"reference/evaluation/interfaces/MakeGenerateConversationDataParams",title:"Interface: MakeGenerateConversationDataParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeGenerateConversationDataParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeGenerateConversationDataParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeGenerateConversationDataParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeGenerateConversationDataParams",title:"Interface: MakeGenerateConversationDataParams",sidebar_label:"MakeGenerateConversationDataParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"GeneratedDataStore",permalink:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore"},next:{title:"MakeMongoDbCommandMetadataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"apiBaseUrl",id:"apibaseurl",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"conversations",id:"conversations",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"httpHeaders",id:"httpheaders",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"sleepMs",id:"sleepms",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,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"apibaseurl",children:"apiBaseUrl"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"apiBaseUrl"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"URL for the server you're evaluating."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"Default"})})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'"http://localhost:3000/api/v1/"\n'})}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/generate/generateConversationData.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/generate/generateConversationData.ts:24"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"conversations",children:"conversations"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"conversations"}),": ",(0,t.jsx)(n.code,{children:"ConversationsService"})]}),"\n",(0,t.jsxs)(n.p,{children:["Same ",(0,t.jsx)(n.code,{children:"ConversationsService"})," instance used in the chatbot.\nThe function uses the service to create conversations and add initial messages."]}),"\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/7463475/packages/mongodb-chatbot-evaluation/src/generate/generateConversationData.ts#L18",children:"packages/mongodb-chatbot-evaluation/src/generate/generateConversationData.ts:18"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"httpheaders",children:"httpHeaders"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"httpHeaders"}),": ",(0,t.jsx)(n.code,{children:"Record"}),"<",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"HTTP headers to include in the request to add a message to a conversation."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"Example"})})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "Authorization": "Bearer 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