Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
Chatbot Root Component",id:"chatbot-root-component",level:3},{value:"ActionButtonTrigger",id:"actionbuttontrigger",level:3},{value:"FloatingActionButtonTrigger",id:"floatingactionbuttontrigger",level:3},{value:"InputBarTrigger",id:"inputbartrigger",level:3},{value:"ModalView",id:"modalview",level:3}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.a)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"chatbot-ui",children:"Chatbot UI"}),"\n",(0,s.jsx)(t.p,{children:"The MongoDB Chatbot UI is a React.js component library that you can use to build a chatbot UI."}),"\n",(0,s.jsx)(t.p,{children:"Currently, it's focused on internal MongoDB use cases. However, we may make it more generic in the future if there is sufficient external interest."}),"\n",(0,s.jsxs)(r,{children:[(0,s.jsx)("summary",{children:" Demo GIF "}),(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Chatbot UI Demo GIF",src:n(30817).Z+"",width:"1308",height:"1054"})})]}),"\n",(0,s.jsx)(t.h2,{id:"install",children:"Install"}),"\n",(0,s.jsxs)(t.p,{children:["Install the ",(0,s.jsx)(t.code,{children:"mongodb-chatbot-ui"})," package from npm. This contains the React.js components that you can use to build a chatbot UI."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"npm install mongodb-chatbot-ui\n"})}),"\n",(0,s.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-tsx",children:'import Chatbot, {\n FloatingActionButtonTrigger,\n InputBarTrigger,\n ModalView,\n MongoDbLegalDisclosure,\n mongoDbVerifyInformationMessage,\n} from "mongodb-chatbot-ui";\n\nfunction MyApp() {\n const suggestedPrompts = [\n "How do I create a new MongoDB Atlas cluster?",\n "Can MongoDB store lists of data?",\n "How does vector search work?",\n ];\n return (\n Chatbot Root Component",id:"chatbot-root-component",level:3},{value:"ActionButtonTrigger",id:"actionbuttontrigger",level:3},{value:"FloatingActionButtonTrigger",id:"floatingactionbuttontrigger",level:3},{value:"InputBarTrigger",id:"inputbartrigger",level:3},{value:"ModalView",id:"modalview",level:3}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.a)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"chatbot-ui",children:"Chatbot UI"}),"\n",(0,s.jsx)(t.p,{children:"The MongoDB Chatbot UI is a React.js component library that you can use to build a chatbot UI."}),"\n",(0,s.jsx)(t.p,{children:"Currently, it's focused on internal MongoDB use cases. However, we may make it more generic in the future if there is sufficient external interest."}),"\n",(0,s.jsxs)(r,{children:[(0,s.jsx)("summary",{children:" Demo GIF "}),(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Chatbot UI Demo GIF",src:n(30817).Z+"",width:"1308",height:"1054"})})]}),"\n",(0,s.jsx)(t.h2,{id:"install",children:"Install"}),"\n",(0,s.jsxs)(t.p,{children:["Install the ",(0,s.jsx)(t.code,{children:"mongodb-chatbot-ui"})," package from npm. This contains the React.js components that you can use to build a chatbot UI."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"npm install mongodb-chatbot-ui\n"})}),"\n",(0,s.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-tsx",children:'import Chatbot, {\n FloatingActionButtonTrigger,\n InputBarTrigger,\n ModalView,\n MongoDbLegalDisclosure,\n mongoDbVerifyInformationMessage,\n} from "mongodb-chatbot-ui";\n\nfunction MyApp() {\n const suggestedPrompts = [\n "How do I create a new MongoDB Atlas cluster?",\n "Can MongoDB store lists of data?",\n "How does vector search work?",\n ];\n return (\n generate",id:"generate",level:2},{value:"evaluate",id:"evaluate",level:2},{value:"report",id:"report",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"cli-command-reference",children:"CLI Command Reference"}),"\n",(0,o.jsx)(n.p,{children:"The MongoDB Chatbot Evaluation CLI has the following commands."}),"\n",(0,o.jsxs)(n.p,{children:["You must install the CLI before you can run it. See the ",(0,o.jsx)(n.a,{href:"/chatbot/evaluation/#install",children:"installation documentation"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["For all commands, you can use the ",(0,o.jsx)(n.code,{children:"--help"})," flag to get more information about the command."]}),"\n",(0,o.jsxs)(n.p,{children:["Run commands with the ",(0,o.jsx)(n.code,{children:"mongodb-chatbot-evaluation"})," CLI application:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:"mongodb-chatbot-evaluation ConfigConstructor",id:"configconstructor",level:2},{value:"Data Stores",id:"data-stores",level:2},{value:"CommandMetadataStore",id:"commandmetadatastore",level:3},{value:"MongoDBCommandMetadataStore",id:"mongodbcommandmetadatastore",level:4},{value:"GeneratedDataStore",id:"generateddatastore",level:3},{value:"MongoDBGeneratedDataStore",id:"mongodbgenerateddatastore",level:4},{value:"EvaluationStore",id:"evaluationstore",level:3},{value:"MongoDBEvaluationStore",id:"mongodbevaluationstore",level:4},{value:"ReportStore",id:"reportstore",level:3},{value:"MongoDBReportStore",id:"mongodbreportstore",level:4},{value:"Test Cases",id:"test-cases",level:2},{value:"Load test cases from a file",id:"load-test-cases-from-a-file",level:3},{value:"Command Executor Functions",id:"command-executor-functions",level:2},{value:"GenerateDataFunc",id:"generatedatafunc",level:3},{value:"EvaluateQualityFunc",id:"evaluatequalityfunc",level:3},{value:"ReportEvalFunc",id:"reportevalfunc",level:3}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"configuration-reference",children:"Configuration Reference"}),"\n",(0,a.jsx)(n.p,{children:"This page contains reference documentation for the configuration options for the MongoDB Chatbot Evaluation CLI."}),"\n",(0,a.jsxs)(n.p,{children:["An Evaluation CLI config file is a CommonJS file that exports a ",(0,a.jsx)(n.code,{children:"ConfigConstructor"})," function as its default export."]}),"\n",(0,a.jsxs)(n.p,{children:["For an example of setting up a configuration file, refer to the ",(0,a.jsx)(n.a,{href:"/chatbot/evaluation/",children:"Configuration"})," documentation."]}),"\n",(0,a.jsxs)(n.p,{children:["You need to install the Evaluation CLI to configure it. Refer to the ",(0,a.jsx)(n.a,{href:"/chatbot/evaluation/#install",children:"Installation"})," documentation for instructions."]}),"\n",(0,a.jsx)(n.h2,{id:"api-reference",children:"API Reference"}),"\n",(0,a.jsxs)(n.p,{children:["For a full API reference of all modules exported by ",(0,a.jsx)(n.code,{children:"mongodb-chatbot-evaluation"}),", refer to the ",(0,a.jsx)(n.a,{href:"../reference/evaluation/",children:"API Reference"})," documentation."]}),"\n",(0,a.jsx)(n.p,{children:"This page links to the key reference documentation for configuring the Ingest CLI."}),"\n",(0,a.jsx)(n.h2,{id:"configconstructor",children:(0,a.jsx)(n.code,{children:"ConfigConstructor"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#configconstructor",children:(0,a.jsx)(n.code,{children:"ConfigConstructor"})})," function is the root configuration type for the Ingest CLI. This exports an ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvalConfig",children:(0,a.jsx)(n.code,{children:"EvalConfig"})})," object."]}),"\n",(0,a.jsx)(n.h2,{id:"data-stores",children:"Data Stores"}),"\n",(0,a.jsx)(n.h3,{id:"commandmetadatastore",children:(0,a.jsx)(n.code,{children:"CommandMetadataStore"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",children:(0,a.jsx)(n.code,{children:"CommandMetadataStore"})})," is an interface for storing metadata of each command run."]}),"\n",(0,a.jsx)(n.h4,{id:"mongodbcommandmetadatastore",children:(0,a.jsx)(n.code,{children:"MongoDBCommandMetadataStore"})}),"\n",(0,a.jsxs)(n.p,{children:["To create a ",(0,a.jsx)(n.code,{children:"CommandMetadataStore"})," that stores data in MongoDB,\nuse the constructor function ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makemongodbcommandmetadatastore",children:(0,a.jsx)(n.code,{children:"makeMongoDbCommandMetadataStore()"})}),"."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbCommandMetadataStore } from "mongodb-chatbot-evaluation";\n\nconst commandMetadataStore = makeMongoDbCommandMetadataStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,a.jsx)(n.h3,{id:"generateddatastore",children:(0,a.jsx)(n.code,{children:"GeneratedDataStore"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",children:(0,a.jsx)(n.code,{children:"GeneratedDataStore"})})," is an interface for storing and working with generated evaluation data."]}),"\n",(0,a.jsx)(n.h4,{id:"mongodbgenerateddatastore",children:(0,a.jsx)(n.code,{children:"MongoDBGeneratedDataStore"})}),"\n",(0,a.jsxs)(n.p,{children:["To create a ",(0,a.jsx)(n.code,{children:"GeneratedDataStore"})," that stores data in MongoDB,\nuse the constructor function ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makemongodbgenerateddatastore",children:(0,a.jsx)(n.code,{children:"makeMongoDbGeneratedDataStore()"})}),"."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbGeneratedDataStore } from "mongodb-chatbot-evaluation";\n\nconst generatedDataStore = makeMongoDbGeneratedDataStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,a.jsx)(n.h3,{id:"evaluationstore",children:(0,a.jsx)(n.code,{children:"EvaluationStore"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/EvaluationStore",children:(0,a.jsx)(n.code,{children:"EvaluationStore"})})," is an interface for storing and accessing the results of an evaluation."]}),"\n",(0,a.jsx)(n.h4,{id:"mongodbevaluationstore",children:(0,a.jsx)(n.code,{children:"MongoDBEvaluationStore"})}),"\n",(0,a.jsxs)(n.p,{children:["To create an ",(0,a.jsx)(n.code,{children:"EvaluationStore"})," that stores data in MongoDB,\nuse the constructor function ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makemongodbevaluationstore",children:(0,a.jsx)(n.code,{children:"makeMongoDbEvaluationStore()"})}),"."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbEvaluationStore } from "mongodb-chatbot-evaluation";\n\nconst evaluationStore = makeMongoDbEvaluationStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,a.jsx)(n.h3,{id:"reportstore",children:(0,a.jsx)(n.code,{children:"ReportStore"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/ReportStore",children:(0,a.jsx)(n.code,{children:"ReportStore"})})," is an interface for storing reports on the results of evaluation runs."]}),"\n",(0,a.jsx)(n.h4,{id:"mongodbreportstore",children:(0,a.jsx)(n.code,{children:"MongoDBReportStore"})}),"\n",(0,a.jsxs)(n.p,{children:["To create a ",(0,a.jsx)(n.code,{children:"ReportStore"})," that stores data in MongoDB,\nuse the constructor function ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makemongodbreportstore",children:(0,a.jsx)(n.code,{children:"makeMongoDbReportStore()"})}),"."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'import { makeMongoDbReportStore } from "mongodb-chatbot-evaluation";\n\nconst reportStore = makeMongoDbReportStore({\n connectionUri: MONGODB_CONNECTION_URI,\n databaseName: MONGODB_DATABASE_NAME,\n});\n'})}),"\n",(0,a.jsx)(n.h2,{id:"test-cases",children:"Test Cases"}),"\n",(0,a.jsxs)(n.p,{children:["You must provide test cases to evaluate the chatbot. Pass the test cases to the ",(0,a.jsx)(n.code,{children:"commands.generate"})," property in the ",(0,a.jsx)(n.code,{children:"EvalConfig"}),"."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-typescript",children:'const testCases: ConversationTestCase[] = [\n {\n name: `It understands "why the chicken crossed the road" jokes`,\n expectation: `\n The ASSISTANT responds with a completion of the classic chicken crossing the road joke.\n The joke should be completed in a way that is both humorous and appropriate.\n `,\n tags: ["joke"],\n messages: [\n { role: "user", content: "Why did the chicken cross the road?" }\n ]\n },\n];\n\nconst evalConfig: EvalConfig = {\n // ... other fields,\n commands: {\n generate: {\n myTest: {\n type: "conversation",\n // highlight-start\n testCases: testCases,\n // highlight-end\n generator: makeGenerateConversationData({ ... }),\n },\n },\n evaluate: { /* ... */ },\n report: { /* ... */ },\n },\n};\n'})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"mongodb-chatbot-evaluation"})," package includes built-in support for the ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/ConversationTestCase",children:(0,a.jsx)(n.code,{children:"ConversationTestCase"})})," type.\nYou can use this to evaluate the chatbot's performance on conversation data."]}),"\n",(0,a.jsx)(n.h3,{id:"load-test-cases-from-a-file",children:"Load test cases from a file"}),"\n",(0,a.jsxs)(n.p,{children:["You can load ",(0,a.jsx)(n.code,{children:"ConversationTestCase"})," object from a YAML file using the ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#getconversationstestcasesfromyaml",children:(0,a.jsx)(n.code,{children:"getConversationsTestCasesFromYaml()"})})," function."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'import { getConversationsTestCasesFromYaml } from "mongodb-chatbot-evaluation";\n\nconst testCases = getConversationsTestCasesFromYaml("path/to/test-cases.yaml");\n'})}),"\n",(0,a.jsx)(n.h2,{id:"command-executor-functions",children:"Command Executor Functions"}),"\n",(0,a.jsx)(n.p,{children:"These functions are used to execute commands in the pipeline.\nThere are different functions for the different commands."}),"\n",(0,a.jsx)(n.h3,{id:"generatedatafunc",children:(0,a.jsx)(n.code,{children:"GenerateDataFunc"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#generatedatafunc",children:(0,a.jsx)(n.code,{children:"GenerateDataFunc"})})," is a function that generates data to be evaluated."]}),"\n",(0,a.jsxs)(n.p,{children:["Pass a ",(0,a.jsx)(n.code,{children:"GenerateDataFunc"})," to the ",(0,a.jsx)(n.code,{children:"commands.generate"})," property in the ",(0,a.jsx)(n.code,{children:"EvalConfig"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"mongodb-chatbot-evaluation"})," package includes the following ",(0,a.jsx)(n.code,{children:"GenerateDataFunc"})," implementation functions:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makegenerateconversationdata",children:(0,a.jsx)(n.code,{children:"makeGenerateConversationData()"})}),": Generates conversation data from the test cases.\nThe function calls a MongoDB Chatbot Server API to create conversations and add messages.\nThis lets you evaluate the chatbot's performance on a running server to get behavior resembling how your actual app behaves."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makegeneratellmconversationdata",children:(0,a.jsx)(n.code,{children:"makeGenerateLlmConversationData()"})}),": Generates conversation data from the test cases.\nThe function calls a ",(0,a.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:(0,a.jsx)(n.code,{children:"ChatLlm"})})," instance to generate responses. This is useful to see how a language model without retrieval-augmented generation performs on a test case."]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Example of using ",(0,a.jsx)(n.code,{children:"makeGenerateConversationData()"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'// eval.config.ts\nimport { makeGenerateConversationData } from "mongodb-chatbot-evaluation";\n\nconst generateDataFunc = makeGenerateConversationData({\n conversations,\n httpHeaders: {\n Origin: "Testing",\n },\n apiBaseUrl: CONVERSATIONS_SERVER_BASE_URL,\n});\n\nexport default async function configConstructor() {\n return {\n // ... other configuration options\n commands: {\n generate: {\n conversations: {\n type: "conversation",\n testCases: someTestCases,\n generator: generateDataFunc,\n },\n },\n // ... other commands\n },\n };\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"evaluatequalityfunc",children:(0,a.jsx)(n.code,{children:"EvaluateQualityFunc"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#evaluatequalityfunc",children:(0,a.jsx)(n.code,{children:"EvaluateQualityFunc"})})," is a function that evaluates some quality of generated data."]}),"\n",(0,a.jsxs)(n.p,{children:["Pass an ",(0,a.jsx)(n.code,{children:"EvaluateQualityFunc"})," to the ",(0,a.jsx)(n.code,{children:"commands.evaluate"})," property in the ",(0,a.jsx)(n.code,{children:"EvalConfig"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"mongodb-chatbot-evaluation"})," package includes the following ",(0,a.jsx)(n.code,{children:"EvaluateQualityFunc"})," implementation functions:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makeevaluateconversationquality",children:(0,a.jsx)(n.code,{children:"makeEvaluateConversationQuality()"})}),": Evaluates the quality of a conversation by comparing the generated response to a provided expectation.\nThe function uses the OpenAI API to evaluate the quality of the responses."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#makeevaluateconversationfaithfulness",children:(0,a.jsx)(n.code,{children:"makeEvaluateConversationFaithfulness()"})}),": Evaluates the faithfulness of a conversation by comparing the generated response to the context information retrieved before generating an answer."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#evaluateconversationaverageretrievalscore",children:(0,a.jsx)(n.code,{children:"evaluateConversationAverageRetrievalScore()"})}),": Evaluates the average retrieval score of a conversation by comparing the generated responses to a provided expectation."]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Example of using ",(0,a.jsx)(n.code,{children:"makeEvaluateConversationQuality()"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'// eval.config.ts\n\nimport { makeEvaluateConversationQuality } from "mongodb-chatbot-evaluation";\nimport { OpenAIClient, AzureKeyCredential } from "@azure/openai";\n\nconst evaluateQualityFunc = makeEvaluateConversationQuality({\n deploymentName: OPENAI_CHAT_COMPLETION_DEPLOYMENT,\n openAiClient: new OpenAIClient(\n OPENAI_ENDPOINT,\n new AzureKeyCredential(OPENAI_API_KEY)\n ),\n});\n\nexport default async function configConstructor() {\n return {\n // ... other configuration options\n commands: {\n evaluate: {\n conversationQuality: {\n evaluator: evaluateQualityFunc,\n },\n },\n // ... other commands\n },\n };\n}\n'})}),"\n",(0,a.jsx)(n.h3,{id:"reportevalfunc",children:(0,a.jsx)(n.code,{children:"ReportEvalFunc"})}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#reportevalfunc",children:(0,a.jsx)(n.code,{children:"ReportEvalFunc"})})," is a function that generates a report from the evaluation data."]}),"\n",(0,a.jsxs)(n.p,{children:["Pass a ",(0,a.jsx)(n.code,{children:"ReportEvalFunc"})," to the ",(0,a.jsx)(n.code,{children:"commands.report"})," property in the ",(0,a.jsx)(n.code,{children:"EvalConfig"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"mongodb-chatbot-evaluation"})," package includes the following ",(0,a.jsx)(n.code,{children:"ReportEvalFunc"})," implementation functions:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#reportstatsforbinaryevalrun",children:(0,a.jsx)(n.code,{children:"reportStatsForBinaryEvalRun()"})}),": Generates a report for a binary evaluation run, one that has results of either ",(0,a.jsx)(n.code,{children:"0"})," or ",(0,a.jsx)(n.code,{children:"1"}),"."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#reportaveragescore",children:(0,a.jsx)(n.code,{children:"reportAverageScore()"})}),": Generates a report for the average score of a set of evaluation data."]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Example of using ",(0,a.jsx)(n.code,{children:"reportStatsForBinaryEvalRun()"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:'// eval.config.ts\n\nimport { reportStatsForBinaryEvalRun } from "mongodb-chatbot-evaluation";\n\nexport default async function configConstructor() {\n return {\n // ... other configuration options\n commands: {\n // ... other commands\n report: {\n binaryEvalRun: {\n reporter: reportStatsForBinaryEvalRun,\n },\n },\n },\n };\n}\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.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:()=>c,a:()=>s});var a=t(67294);const o={},r=a.createContext(o);function s(e){const n=a.useContext(r);return a.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(o):e.components||o:s(e.components),a.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d8792099.2bd479dc.js b/assets/js/d8792099.cedb3557.js
similarity index 95%
rename from assets/js/d8792099.2bd479dc.js
rename to assets/js/d8792099.cedb3557.js
index 474281509..c81310dfd 100644
--- a/assets/js/d8792099.2bd479dc.js
+++ b/assets/js/d8792099.cedb3557.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7423],{90374:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=s(85893),t=s(11151);const o={id:"ConversationsRouterParams",title:"Interface: ConversationsRouterParams",sidebar_label:"ConversationsRouterParams",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ConversationsRouterParams",title:"Interface: ConversationsRouterParams",description:"Configuration for the /conversations/* routes.",source:"@site/docs/reference/server/interfaces/ConversationsRouterParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRouterParams",title:"Interface: ConversationsRouterParams",sidebar_label:"ConversationsRouterParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals"},next:{title:"ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"addMessageToConversationCustomData",id:"addmessagetoconversationcustomdata",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:"createConversationCustomData",id:"createconversationcustomdata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"filterPreviousMessages",id:"filterpreviousmessages",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"generateUserPrompt",id:"generateuserprompt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"llm",id:"llm",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxInputLengthCharacters",id:"maxinputlengthcharacters",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxUserCommentLength",id:"maxusercommentlength",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxUserMessagesInConversation",id:"maxusermessagesinconversation",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"middleware",id:"middleware",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"rateLimitConfig",id:"ratelimitconfig",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"systemPrompt",id:"systemprompt",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Configuration for the /conversations/* routes."}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"addmessagetoconversationcustomdata",children:"addMessageToConversationCustomData"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"addMessageToConversationCustomData"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#addcustomdatafunc",children:(0,r.jsx)(n.code,{children:"AddCustomDataFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function that takes the request + response and returns any custom data you want to include\nin the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," persisted to the database.\nFor example, you might want to store details about what LLM was used to generate the response.\nThe custom data is persisted to the database with the ",(0,r.jsx)(n.code,{children:"Message"})," in the\nMessage.customData field inside of the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation#messages",children:"Conversation.messages"})," array."]}),"\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/routes/conversations/conversationsRouter.ts#L185",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:185"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"conversations",children:"conversations"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"conversations"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,r.jsx)(n.code,{children:"ConversationsService"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-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/routes/conversations/conversationsRouter.ts#L118",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:118"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"createconversationcustomdata",children:"createConversationCustomData"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"createConversationCustomData"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#addcustomdatafunc",children:(0,r.jsx)(n.code,{children:"AddCustomDataFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function that takes the request + response and returns any custom data you want to include\nin the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"})," persisted to the database.\nFor example, you might want to store the user's email address with the conversation.\nThe custom data is persisted to the database with the Conversation in the\n",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation#customdata",children:"Conversation.customData"})," field."]}),"\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/routes/conversations/conversationsRouter.ts#L176",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:176"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"filterpreviousmessages",children:"filterPreviousMessages"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"filterPreviousMessages"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#filterpreviousmessages",children:(0,r.jsx)(n.code,{children:"FilterPreviousMessages"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function to filter which previous messages are sent to the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:"ChatLlm"}),".\nFor example, you may only want to send the system prompt to the LLM\nwith the user message or the system prompt and X prior messages.\nDefaults to sending only the system prompt."]}),"\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/routes/conversations/conversationsRouter.ts#L140",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:140"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generateuserprompt",children:"generateUserPrompt"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"generateUserPrompt"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,r.jsx)(n.code,{children:"GenerateUserPromptFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function to generate the user prompt sent to the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:"ChatLlm"}),".\nYou can perform any preprocessing of the user's message\nincluding retrieval augmented generation here."]}),"\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/routes/conversations/conversationsRouter.ts#L126",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:126"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"llm",children:"llm"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"llm"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:(0,r.jsx)(n.code,{children:"ChatLlm"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",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/routes/conversations/conversationsRouter.ts#L117",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:117"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxinputlengthcharacters",children:"maxInputLengthCharacters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxInputLengthCharacters"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Maximum number of characters in user input.\nServer returns 400 error if user input is longer than this."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",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/routes/conversations/conversationsRouter.ts#L132",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:132"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxusercommentlength",children:"maxUserCommentLength"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxUserCommentLength"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsxs)(n.p,{children:["Maximum number of characters allowed in a user's comment on an assistant ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#message",children:"Message"}),".\nIf not specified, user comments may be of any length."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",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/routes/conversations/conversationsRouter.ts#L191",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:191"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxusermessagesinconversation",children:"maxUserMessagesInConversation"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxUserMessagesInConversation"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Maximum number of user-sent messages in a conversation.\nServer returns 400 error if user tries to add a message to a conversation\nthat has this many messages."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-8",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/routes/conversations/conversationsRouter.ts#L147",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:147"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"middleware",children:"middleware"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"middleware"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#conversationsmiddleware",children:(0,r.jsx)(n.code,{children:"ConversationsMiddleware"})}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"Middleware to put in front of all the routes in the conversationsRouter.\nYou can use this to do things like authentication, data validation, etc."}),"\n",(0,r.jsx)(n.p,{children:"If you want the middleware to run only on certain routes,\nyou can add conditional logic inside the middleware. For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'const someMiddleware: ConversationsMiddleware = (req, res, next) => {\n if (req.path === "/conversations") {\n // Do something\n }\n next();\n}\n'})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-9",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/routes/conversations/conversationsRouter.ts#L167",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:167"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ratelimitconfig",children:"rateLimitConfig"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"rateLimitConfig"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig",children:(0,r.jsx)(n.code,{children:"ConversationsRateLimitConfig"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-10",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/routes/conversations/conversationsRouter.ts#L148",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:148"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"systemprompt",children:"systemPrompt"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"systemPrompt"}),": ",(0,r.jsx)(n.code,{children:"Object"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"embedding?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The vector representation of the content."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-11",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/routes/conversations/conversationsRouter.ts#L119",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:119"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},11151:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(67294);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7423],{90374:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=s(85893),t=s(11151);const o={id:"ConversationsRouterParams",title:"Interface: ConversationsRouterParams",sidebar_label:"ConversationsRouterParams",sidebar_position:0,custom_edit_url:null},i=void 0,a={id:"reference/server/interfaces/ConversationsRouterParams",title:"Interface: ConversationsRouterParams",description:"Configuration for the /conversations/* routes.",source:"@site/docs/reference/server/interfaces/ConversationsRouterParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsRouterParams",title:"Interface: ConversationsRouterParams",sidebar_label:"ConversationsRouterParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRouterLocals",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterLocals"},next:{title:"ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"addMessageToConversationCustomData",id:"addmessagetoconversationcustomdata",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:"createConversationCustomData",id:"createconversationcustomdata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"filterPreviousMessages",id:"filterpreviousmessages",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"generateUserPrompt",id:"generateuserprompt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"llm",id:"llm",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxInputLengthCharacters",id:"maxinputlengthcharacters",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxUserCommentLength",id:"maxusercommentlength",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxUserMessagesInConversation",id:"maxusermessagesinconversation",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"middleware",id:"middleware",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"rateLimitConfig",id:"ratelimitconfig",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"systemPrompt",id:"systemprompt",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Configuration for the /conversations/* routes."}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"addmessagetoconversationcustomdata",children:"addMessageToConversationCustomData"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"addMessageToConversationCustomData"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#addcustomdatafunc",children:(0,r.jsx)(n.code,{children:"AddCustomDataFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function that takes the request + response and returns any custom data you want to include\nin the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," persisted to the database.\nFor example, you might want to store details about what LLM was used to generate the response.\nThe custom data is persisted to the database with the ",(0,r.jsx)(n.code,{children:"Message"})," in the\nMessage.customData field inside of the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation#messages",children:"Conversation.messages"})," array."]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L185",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:185"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"conversations",children:"conversations"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"conversations"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsService",children:(0,r.jsx)(n.code,{children:"ConversationsService"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L118",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:118"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"createconversationcustomdata",children:"createConversationCustomData"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"createConversationCustomData"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#addcustomdatafunc",children:(0,r.jsx)(n.code,{children:"AddCustomDataFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function that takes the request + response and returns any custom data you want to include\nin the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"})," persisted to the database.\nFor example, you might want to store the user's email address with the conversation.\nThe custom data is persisted to the database with the Conversation in the\n",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Conversation#customdata",children:"Conversation.customData"})," field."]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L176",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:176"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"filterpreviousmessages",children:"filterPreviousMessages"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"filterPreviousMessages"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#filterpreviousmessages",children:(0,r.jsx)(n.code,{children:"FilterPreviousMessages"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function to filter which previous messages are sent to the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:"ChatLlm"}),".\nFor example, you may only want to send the system prompt to the LLM\nwith the user message or the system prompt and X prior messages.\nDefaults to sending only the system prompt."]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L140",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:140"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generateuserprompt",children:"generateUserPrompt"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"generateUserPrompt"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#generateuserpromptfunc",children:(0,r.jsx)(n.code,{children:"GenerateUserPromptFunc"})})]}),"\n",(0,r.jsxs)(n.p,{children:["Function to generate the user prompt sent to the ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:"ChatLlm"}),".\nYou can perform any preprocessing of the user's message\nincluding retrieval augmented generation here."]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L126",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:126"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"llm",children:"llm"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"llm"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ChatLlm",children:(0,r.jsx)(n.code,{children:"ChatLlm"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L117",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:117"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxinputlengthcharacters",children:"maxInputLengthCharacters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxInputLengthCharacters"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Maximum number of characters in user input.\nServer returns 400 error if user input is longer than this."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L132",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:132"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxusercommentlength",children:"maxUserCommentLength"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxUserCommentLength"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsxs)(n.p,{children:["Maximum number of characters allowed in a user's comment on an assistant ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#message",children:"Message"}),".\nIf not specified, user comments may be of any length."]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L191",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:191"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"maxusermessagesinconversation",children:"maxUserMessagesInConversation"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"maxUserMessagesInConversation"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Maximum number of user-sent messages in a conversation.\nServer returns 400 error if user tries to add a message to a conversation\nthat has this many messages."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L147",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:147"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"middleware",children:"middleware"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"middleware"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/modules#conversationsmiddleware",children:(0,r.jsx)(n.code,{children:"ConversationsMiddleware"})}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"Middleware to put in front of all the routes in the conversationsRouter.\nYou can use this to do things like authentication, data validation, etc."}),"\n",(0,r.jsx)(n.p,{children:"If you want the middleware to run only on certain routes,\nyou can add conditional logic inside the middleware. For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'const someMiddleware: ConversationsMiddleware = (req, res, next) => {\n if (req.path === "/conversations") {\n // Do something\n }\n next();\n}\n'})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L167",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:167"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ratelimitconfig",children:"rateLimitConfig"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"rateLimitConfig"}),": ",(0,r.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig",children:(0,r.jsx)(n.code,{children:"ConversationsRateLimitConfig"})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L148",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:148"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"systemprompt",children:"systemPrompt"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"systemPrompt"}),": ",(0,r.jsx)(n.code,{children:"Object"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"embedding?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The vector representation of the content."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts#L119",children:"packages/mongodb-chatbot-server/src/routes/conversations/conversationsRouter.ts:119"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},11151:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(67294);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d9cc7f9d.82241b37.js b/assets/js/d9cc7f9d.82241b37.js
deleted file mode 100644
index 3e38efeb0..000000000
--- a/assets/js/d9cc7f9d.82241b37.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1264],{88514:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var s=n(85893),r=n(11151);const i={id:"ConversationTestCase",title:"Interface: ConversationTestCase",sidebar_label:"ConversationTestCase",sidebar_position:0,custom_edit_url:null},a=void 0,l={id:"reference/evaluation/interfaces/ConversationTestCase",title:"Interface: ConversationTestCase",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/ConversationTestCase.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/ConversationTestCase",permalink:"/chatbot/reference/evaluation/interfaces/ConversationTestCase",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationTestCase",title:"Interface: ConversationTestCase",sidebar_label:"ConversationTestCase",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationGeneratedData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationGeneratedData"},next:{title:"EvalConfig",permalink:"/chatbot/reference/evaluation/interfaces/EvalConfig"}},d={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const t={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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:(0,s.jsx)(t.code,{children:"BaseTestCase"})})}),"\n",(0,s.jsxs)(t.p,{children:["\u21b3 ",(0,s.jsx)(t.strong,{children:(0,s.jsx)(t.code,{children:"ConversationTestCase"})})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"data"}),": ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsx)(t.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"expectation"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"string"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"messages"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:'{ role: "assistant" | "user"; content: string; }[]'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"name"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"string"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"skip?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"boolean"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"tags?"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,s.jsx)(t.code,{children:"string"}),"[]"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:"BaseTestCase"}),".",(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase#data",children:"data"})]}),"\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/generate/TestCase.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts:28"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"name"}),": ",(0,s.jsx)(t.code,{children:'"conversation"'})]}),"\n",(0,s.jsx)(t.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:"BaseTestCase"}),".",(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase#name",children:"name"})]}),"\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/generate/TestCase.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts:29"})})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>a});var s=n(67294);const r={},i=s.createContext(r);function a(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d9cc7f9d.cf75a1d1.js b/assets/js/d9cc7f9d.cf75a1d1.js
new file mode 100644
index 000000000..a93661f57
--- /dev/null
+++ b/assets/js/d9cc7f9d.cf75a1d1.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1264],{88514:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var s=n(85893),r=n(11151);const i={id:"ConversationTestCase",title:"Interface: ConversationTestCase",sidebar_label:"ConversationTestCase",sidebar_position:0,custom_edit_url:null},a=void 0,l={id:"reference/evaluation/interfaces/ConversationTestCase",title:"Interface: ConversationTestCase",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/ConversationTestCase.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/ConversationTestCase",permalink:"/chatbot/reference/evaluation/interfaces/ConversationTestCase",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationTestCase",title:"Interface: ConversationTestCase",sidebar_label:"ConversationTestCase",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationGeneratedData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationGeneratedData"},next:{title:"EvalConfig",permalink:"/chatbot/reference/evaluation/interfaces/EvalConfig"}},d={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const t={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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:(0,s.jsx)(t.code,{children:"BaseTestCase"})})}),"\n",(0,s.jsxs)(t.p,{children:["\u21b3 ",(0,s.jsx)(t.strong,{children:(0,s.jsx)(t.code,{children:"ConversationTestCase"})})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"data"}),": ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsx)(t.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"expectation?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"string"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"expectedLinks?"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,s.jsx)(t.code,{children:"string"}),"[]"]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"messages"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:'{ role: "assistant" | "user"; content: string; }[]'})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"name"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"string"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"skip?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"boolean"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"tags?"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,s.jsx)(t.code,{children:"string"}),"[]"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:"BaseTestCase"}),".",(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase#data",children:"data"})]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts#L37",children:"packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts:37"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"name"}),": ",(0,s.jsx)(t.code,{children:'"conversation"'})]}),"\n",(0,s.jsx)(t.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase",children:"BaseTestCase"}),".",(0,s.jsx)(t.a,{href:"/chatbot/reference/evaluation/interfaces/BaseTestCase#name",children:"name"})]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts#L38",children:"packages/mongodb-chatbot-evaluation/src/generate/TestCase.ts:38"})})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},11151:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>a});var s=n(67294);const r={},i=s.createContext(r);function a(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/dd6b762f.aa37ec5d.js b/assets/js/dd6b762f.58302cbb.js
similarity index 90%
rename from assets/js/dd6b762f.aa37ec5d.js
rename to assets/js/dd6b762f.58302cbb.js
index c276fa0bd..baea2bc1a 100644
--- a/assets/js/dd6b762f.aa37ec5d.js
+++ b/assets/js/dd6b762f.58302cbb.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2834],{12442:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=t(85893),d=t(11151);const a={id:"GeneratedDataStore",title:"Interface: GeneratedDataStore",sidebar_label:"GeneratedDataStore",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/GeneratedDataStore",title:"Interface: GeneratedDataStore",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/GeneratedDataStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/GeneratedDataStore",permalink:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GeneratedDataStore",title:"Interface: GeneratedDataStore",sidebar_label:"GeneratedDataStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"GenerateDataFuncParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams"},next:{title:"MakeGenerateConversationDataParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeGenerateConversationDataParams"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{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:"find",id:"find",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:"findByCommandRunId",id:"findbycommandrunid",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:"findById",id:"findbyid",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:"insertMany",id:"insertmany",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},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",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,d.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"GeneratedDataStore"})})}),"\n",(0,r.jsxs)(n.p,{children:["\u21b3 ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/MongoDbGeneratedDataStore",children:(0,r.jsx)(n.code,{children:"MongoDbGeneratedDataStore"})})]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"close",children:"close"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"close"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\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-evaluation/src/generate/GeneratedDataStore.ts#L45",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:45"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"find",children:"find"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"find"}),"(",(0,r.jsx)(n.code,{children:"filter"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"filter"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"unknown"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\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-evaluation/src/generate/GeneratedDataStore.ts#L44",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"findbycommandrunid",children:"findByCommandRunId"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"findByCommandRunId"}),"(",(0,r.jsx)(n.code,{children:"commandRunId"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"commandRunId"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"ObjectId"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\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-evaluation/src/generate/GeneratedDataStore.ts#L41",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:41"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"findbyid",children:"findById"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"findById"}),"(",(0,r.jsx)(n.code,{children:"generatedDataId"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedDataId"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"ObjectId"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),">"]}),"\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-evaluation/src/generate/GeneratedDataStore.ts#L40",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:40"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insertmany",children:"insertMany"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"insertMany"}),"(",(0,r.jsx)(n.code,{children:"generatedData"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedData"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\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-evaluation/src/generate/GeneratedDataStore.ts#L39",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:39"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insertone",children:"insertOne"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"insertOne"}),"(",(0,r.jsx)(n.code,{children:"generatedData"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedData"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",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-evaluation/src/generate/GeneratedDataStore.ts#L38",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:38"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var r=t(67294);const d={},a=r.createContext(d);function i(e){const n=r.useContext(a);return r.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(d):e.components||d:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2834],{12442:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=t(85893),d=t(11151);const a={id:"GeneratedDataStore",title:"Interface: GeneratedDataStore",sidebar_label:"GeneratedDataStore",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/GeneratedDataStore",title:"Interface: GeneratedDataStore",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/GeneratedDataStore.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/GeneratedDataStore",permalink:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GeneratedDataStore",title:"Interface: GeneratedDataStore",sidebar_label:"GeneratedDataStore",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"GenerateDataFuncParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams"},next:{title:"MakeGenerateConversationDataParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeGenerateConversationDataParams"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{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:"find",id:"find",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:"findByCommandRunId",id:"findbycommandrunid",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:"findById",id:"findbyid",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:"insertMany",id:"insertmany",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},{value:"insertOne",id:"insertone",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",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,d.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"GeneratedDataStore"})})}),"\n",(0,r.jsxs)(n.p,{children:["\u21b3 ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/interfaces/MongoDbGeneratedDataStore",children:(0,r.jsx)(n.code,{children:"MongoDbGeneratedDataStore"})})]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"close",children:"close"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"close"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L50",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:50"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"find",children:"find"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"find"}),"(",(0,r.jsx)(n.code,{children:"filter"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"filter"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"unknown"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L49",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:49"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"findbycommandrunid",children:"findByCommandRunId"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"findByCommandRunId"}),"(",(0,r.jsx)(n.code,{children:"commandRunId"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"commandRunId"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"ObjectId"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]>"]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L46",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:46"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"findbyid",children:"findById"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"findById"}),"(",(0,r.jsx)(n.code,{children:"generatedDataId"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedDataId"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"ObjectId"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),">"]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L45",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:45"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insertmany",children:"insertMany"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"insertMany"}),"(",(0,r.jsx)(n.code,{children:"generatedData"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedData"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L44",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insertone",children:"insertOne"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"insertOne"}),"(",(0,r.jsx)(n.code,{children:"generatedData"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"generatedData"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/chatbot/reference/evaluation/modules#somegenerateddata",children:(0,r.jsx)(n.code,{children:"SomeGeneratedData"})})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L43",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:43"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var r=t(67294);const d={},a=r.createContext(d);function i(e){const n=r.useContext(a);return r.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(d):e.components||d:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/e6673042.3bad0405.js b/assets/js/e6673042.6a8ef984.js
similarity index 64%
rename from assets/js/e6673042.3bad0405.js
rename to assets/js/e6673042.6a8ef984.js
index d9d918c5e..a43b6c092 100644
--- a/assets/js/e6673042.3bad0405.js
+++ b/assets/js/e6673042.6a8ef984.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6816],{98207:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var t=i(85893),r=i(11151);const s={id:"MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",sidebar_label:"MakeOpenAiChatLlmParams",sidebar_position:0,custom_edit_url:null},o=void 0,a={id:"reference/server/interfaces/MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",description:"Configuration for the makeOpenAiChatLlm function.",source:"@site/docs/reference/server/interfaces/MakeOpenAiChatLlmParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/MakeOpenAiChatLlmParams",permalink:"/chatbot/reference/server/interfaces/MakeOpenAiChatLlmParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",sidebar_label:"MakeOpenAiChatLlmParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeLangchainChatLlmProps",permalink:"/chatbot/reference/server/interfaces/MakeLangchainChatLlmProps"},next:{title:"MakeRagGenerateUserPromptParams",permalink:"/chatbot/reference/server/interfaces/MakeRagGenerateUserPromptParams"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"deployment",id:"deployment",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"openAiClient",id:"openaiclient",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openAiLmmConfigOptions",id:"openailmmconfigoptions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tools",id:"tools",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["Configuration for the ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/modules#makeopenaichatllm",children:"makeOpenAiChatLlm"})," function."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"deployment",children:"deployment"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"deployment"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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-server/src/services/openAiChatLlm.ts#L21",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:21"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"openaiclient",children:"openAiClient"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"openAiClient"}),": ",(0,t.jsx)(n.code,{children:"OpenAIClient"})]}),"\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-server/src/services/openAiChatLlm.ts#L22",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"openailmmconfigoptions",children:"openAiLmmConfigOptions"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"openAiLmmConfigOptions"}),": ",(0,t.jsx)(n.code,{children:"GetChatCompletionsOptions"})]}),"\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-server/src/services/openAiChatLlm.ts#L23",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:23"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"tools",children:"tools"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"tools"}),": ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Tool",children:(0,t.jsx)(n.code,{children:"Tool"})}),"[]"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts#L24",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:24"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},11151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(67294);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.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:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6816],{98207:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var t=i(85893),r=i(11151);const s={id:"MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",sidebar_label:"MakeOpenAiChatLlmParams",sidebar_position:0,custom_edit_url:null},o=void 0,a={id:"reference/server/interfaces/MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",description:"Configuration for the makeOpenAiChatLlm function.",source:"@site/docs/reference/server/interfaces/MakeOpenAiChatLlmParams.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/MakeOpenAiChatLlmParams",permalink:"/chatbot/reference/server/interfaces/MakeOpenAiChatLlmParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeOpenAiChatLlmParams",title:"Interface: MakeOpenAiChatLlmParams",sidebar_label:"MakeOpenAiChatLlmParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeLangchainChatLlmProps",permalink:"/chatbot/reference/server/interfaces/MakeLangchainChatLlmProps"},next:{title:"MakeRagGenerateUserPromptParams",permalink:"/chatbot/reference/server/interfaces/MakeRagGenerateUserPromptParams"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"deployment",id:"deployment",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"openAiClient",id:"openaiclient",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openAiLmmConfigOptions",id:"openailmmconfigoptions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tools",id:"tools",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["Configuration for the ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/modules#makeopenaichatllm",children:"makeOpenAiChatLlm"})," function."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"deployment",children:"deployment"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"deployment"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts#L21",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:21"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"openaiclient",children:"openAiClient"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"openAiClient"}),": ",(0,t.jsx)(n.code,{children:"OpenAIClient"})]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts#L22",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"openailmmconfigoptions",children:"openAiLmmConfigOptions"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"openAiLmmConfigOptions"}),": ",(0,t.jsx)(n.code,{children:"GetChatCompletionsOptions"})]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts#L23",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:23"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"tools",children:"tools"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"tools"}),": ",(0,t.jsx)(n.a,{href:"/chatbot/reference/server/interfaces/Tool",children:(0,t.jsx)(n.code,{children:"Tool"})}),"[]"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts#L24",children:"packages/mongodb-chatbot-server/src/services/openAiChatLlm.ts:24"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},11151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(67294);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.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:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f4e3b7a1.5c87d80d.js b/assets/js/f4e3b7a1.24c13d06.js
similarity index 92%
rename from assets/js/f4e3b7a1.5c87d80d.js
rename to assets/js/f4e3b7a1.24c13d06.js
index 329f75a2d..4bfcedb25 100644
--- a/assets/js/f4e3b7a1.5c87d80d.js
+++ b/assets/js/f4e3b7a1.24c13d06.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2264],{63418:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var n=s(85893),t=s(11151);const a={id:"ConversationsService",title:"Interface: ConversationsService",sidebar_label:"ConversationsService",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"reference/server/interfaces/ConversationsService",title:"Interface: ConversationsService",description:"Service for managing Conversations.",source:"@site/docs/reference/server/interfaces/ConversationsService.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsService",title:"Interface: ConversationsService",sidebar_label:"ConversationsService",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams"},next:{title:"DataStreamer",permalink:"/chatbot/reference/server/interfaces/DataStreamer"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"addConversationMessage",id:"addconversationmessage",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"addManyConversationMessages",id:"addmanyconversationmessages",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"commentMessage",id:"commentmessage",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:4},{value:"conversationConstants",id:"conversationconstants",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"create",id:"create",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-4",level:4},{value:"findById",id:"findbyid",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"Returns",id:"returns-4",level:5},{value:"Defined in",id:"defined-in-5",level:4},{value:"rateMessage",id:"ratemessage",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"Returns",id:"returns-5",level:5},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["Service for managing ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"s."]}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"addconversationmessage",children:"addConversationMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"addConversationMessage"}),": (",(0,n.jsx)(r.code,{children:"params"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addconversationmessageparams",children:(0,n.jsx)(r.code,{children:"AddConversationMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Add a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," to a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{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:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addconversationmessageparams",children:(0,n.jsx)(r.code,{children:"AddConversationMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{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/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\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/ConversationsService.ts#L240",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:240"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addmanyconversationmessages",children:"addManyConversationMessages"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"addManyConversationMessages"}),": (",(0,n.jsx)(r.code,{children:"params"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addmanyconversationmessagesparams",children:(0,n.jsx)(r.code,{children:"AddManyConversationMessagesParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\n",(0,n.jsxs)(r.p,{children:["Add multiple ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," objects to a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addmanyconversationmessagesparams",children:(0,n.jsx)(r.code,{children:"AddManyConversationMessagesParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-1",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/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\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/ConversationsService.ts#L246",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:246"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"commentmessage",children:"commentMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"commentMessage"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CommentMessageParams",children:(0,n.jsx)(r.code,{children:"CommentMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-2",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Add a user comment to an assistant ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CommentMessageParams",children:(0,n.jsx)(r.code,{children:"CommentMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L263",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:263"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"conversationconstants",children:"conversationConstants"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"conversationConstants"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/ConversationConstants",children:(0,n.jsx)(r.code,{children:"ConversationConstants"})})]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L230",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:230"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"create"}),": (",(0,n.jsx)(r.code,{children:"params?"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#createconversationparams",children:(0,n.jsx)(r.code,{children:"CreateConversationParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-3",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params?"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsxs)(r.p,{children:["Create a new ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params?"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#createconversationparams",children:(0,n.jsx)(r.code,{children:"CreateConversationParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-3",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/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L235",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:235"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"findbyid",children:"findById"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"findById"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/FindByIdParams",children:(0,n.jsx)(r.code,{children:"FindByIdParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-4",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-4",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:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/FindByIdParams",children:(0,n.jsx)(r.code,{children:"FindByIdParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-5",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/ConversationsService.ts#L249",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:249"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ratemessage",children:"rateMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"rateMessage"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/RateMessageParams",children:(0,n.jsx)(r.code,{children:"RateMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-5",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Rate a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," in a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-5",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:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/RateMessageParams",children:(0,n.jsx)(r.code,{children:"RateMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-6",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/ConversationsService.ts#L254",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:254"})})]})}function h(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},11151:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>i});var n=s(67294);const t={},a=n.createContext(t);function i(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2264],{63418:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var n=s(85893),t=s(11151);const a={id:"ConversationsService",title:"Interface: ConversationsService",sidebar_label:"ConversationsService",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"reference/server/interfaces/ConversationsService",title:"Interface: ConversationsService",description:"Service for managing Conversations.",source:"@site/docs/reference/server/interfaces/ConversationsService.md",sourceDirName:"reference/server/interfaces",slug:"/reference/server/interfaces/ConversationsService",permalink:"/chatbot/reference/server/interfaces/ConversationsService",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationsService",title:"Interface: ConversationsService",sidebar_label:"ConversationsService",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ConversationsRouterParams",permalink:"/chatbot/reference/server/interfaces/ConversationsRouterParams"},next:{title:"DataStreamer",permalink:"/chatbot/reference/server/interfaces/DataStreamer"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"addConversationMessage",id:"addconversationmessage",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"addManyConversationMessages",id:"addmanyconversationmessages",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"commentMessage",id:"commentmessage",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:4},{value:"conversationConstants",id:"conversationconstants",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"create",id:"create",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-4",level:4},{value:"findById",id:"findbyid",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"Returns",id:"returns-4",level:5},{value:"Defined in",id:"defined-in-5",level:4},{value:"rateMessage",id:"ratemessage",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"Returns",id:"returns-5",level:5},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["Service for managing ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"s."]}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"addconversationmessage",children:"addConversationMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"addConversationMessage"}),": (",(0,n.jsx)(r.code,{children:"params"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addconversationmessageparams",children:(0,n.jsx)(r.code,{children:"AddConversationMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Add a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," to a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{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:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addconversationmessageparams",children:(0,n.jsx)(r.code,{children:"AddConversationMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{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/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),">"]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L247",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:247"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addmanyconversationmessages",children:"addManyConversationMessages"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"addManyConversationMessages"}),": (",(0,n.jsx)(r.code,{children:"params"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addmanyconversationmessagesparams",children:(0,n.jsx)(r.code,{children:"AddManyConversationMessagesParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\n",(0,n.jsxs)(r.p,{children:["Add multiple ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," objects to a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#addmanyconversationmessagesparams",children:(0,n.jsx)(r.code,{children:"AddManyConversationMessagesParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-1",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/modules#message",children:(0,n.jsx)(r.code,{children:"Message"})}),"[]>"]}),"\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/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L253",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:253"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"commentmessage",children:"commentMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"commentMessage"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CommentMessageParams",children:(0,n.jsx)(r.code,{children:"CommentMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-2",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Add a user comment to an assistant ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/CommentMessageParams",children:(0,n.jsx)(r.code,{children:"CommentMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L270",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:270"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"conversationconstants",children:"conversationConstants"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"conversationConstants"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/ConversationConstants",children:(0,n.jsx)(r.code,{children:"ConversationConstants"})})]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L237",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:237"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"create"}),": (",(0,n.jsx)(r.code,{children:"params?"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#createconversationparams",children:(0,n.jsx)(r.code,{children:"CreateConversationParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-3",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"params?"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsxs)(r.p,{children:["Create a new ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.code,{children:"params?"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#createconversationparams",children:(0,n.jsx)(r.code,{children:"CreateConversationParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-3",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/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L242",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:242"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"findbyid",children:"findById"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"findById"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/FindByIdParams",children:(0,n.jsx)(r.code,{children:"FindByIdParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-4",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-4",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:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/FindByIdParams",children:(0,n.jsx)(r.code,{children:"FindByIdParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"null"})," | ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:(0,n.jsx)(r.code,{children:"Conversation"})}),"<",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#conversationcustomdata",children:(0,n.jsx)(r.code,{children:"ConversationCustomData"})}),">>"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L256",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:256"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ratemessage",children:"rateMessage"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"rateMessage"}),": (",(0,n.jsx)(r.code,{children:"__namedParameters"}),": ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/RateMessageParams",children:(0,n.jsx)(r.code,{children:"RateMessageParams"})}),") => ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"type-declaration-5",children:"Type declaration"}),"\n",(0,n.jsxs)(r.p,{children:["\u25b8 (",(0,n.jsx)(r.code,{children:"\xabdestructured\xbb"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsxs)(r.p,{children:["Rate a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/modules#message",children:"Message"})," in a ",(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/Conversation",children:"Conversation"}),"."]}),"\n",(0,n.jsx)(r.h5,{id:"parameters-5",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:"\xabdestructured\xbb"})}),(0,n.jsx)(r.td,{style:{textAlign:"left"},children:(0,n.jsx)(r.a,{href:"/chatbot/reference/server/interfaces/RateMessageParams",children:(0,n.jsx)(r.code,{children:"RateMessageParams"})})})]})})]}),"\n",(0,n.jsx)(r.h5,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-server/src/services/ConversationsService.ts#L261",children:"packages/mongodb-chatbot-server/src/services/ConversationsService.ts:261"})})]})}function h(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},11151:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>i});var n=s(67294);const t={},a=n.createContext(t);function i(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f5f59c64.0d0e97a6.js b/assets/js/f5f59c64.669abb5b.js
similarity index 85%
rename from assets/js/f5f59c64.0d0e97a6.js
rename to assets/js/f5f59c64.669abb5b.js
index f302e761b..68e4f6772 100644
--- a/assets/js/f5f59c64.0d0e97a6.js
+++ b/assets/js/f5f59c64.669abb5b.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6516],{24124:(e,a,n)=>{n.r(a),n.d(a,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=n(85893),o=n(11151);const r={id:"MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",sidebar_label:"MakeMongoDbCommandMetadataStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,d={id:"reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",sidebar_label:"MakeMongoDbCommandMetadataStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeGenerateLlmConversationDataParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeGenerateLlmConversationDataParams"},next:{title:"MakeMongoDbEvaluationStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams"}},s={},c=[{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 a={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(a.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(a.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.code,{children:"Optional"})," ",(0,t.jsx)(a.strong,{children:"collectionName"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.strong,{children:(0,t.jsx)(a.code,{children:"Default"})})}),"\n",(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-ts",children:'"command_run_metadata"\n'})}),"\n",(0,t.jsx)(a.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L33",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:33"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.strong,{children:"connectionUri"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L27",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:27"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h3,{id:"databasename",children:"databaseName"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.strong,{children:"databaseName"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:28"})})]})}function m(e={}){const{wrapper:a}={...(0,o.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},11151:(e,a,n)=>{n.d(a,{Z:()=>d,a:()=>i});var t=n(67294);const o={},r=t.createContext(o);function i(e){const a=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function d(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(r.Provider,{value:a},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6516],{24124:(e,a,n)=>{n.r(a),n.d(a,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var t=n(85893),o=n(11151);const r={id:"MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",sidebar_label:"MakeMongoDbCommandMetadataStoreParams",sidebar_position:0,custom_edit_url:null},i=void 0,s={id:"reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MakeMongoDbCommandMetadataStoreParams",title:"Interface: MakeMongoDbCommandMetadataStoreParams",sidebar_label:"MakeMongoDbCommandMetadataStoreParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"MakeGenerateLlmConversationDataParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeGenerateLlmConversationDataParams"},next:{title:"MakeMongoDbEvaluationStoreParams",permalink:"/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams"}},d={},c=[{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 a={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(a.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(a.h3,{id:"collectionname",children:"collectionName"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.code,{children:"Optional"})," ",(0,t.jsx)(a.strong,{children:"collectionName"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.strong,{children:(0,t.jsx)(a.code,{children:"Default"})})}),"\n",(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-ts",children:'"command_run_metadata"\n'})}),"\n",(0,t.jsx)(a.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L33",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:33"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h3,{id:"connectionuri",children:"connectionUri"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.strong,{children:"connectionUri"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L27",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:27"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h3,{id:"databasename",children:"databaseName"}),"\n",(0,t.jsxs)(a.p,{children:["\u2022 ",(0,t.jsx)(a.strong,{children:"databaseName"}),": ",(0,t.jsx)(a.code,{children:"string"})]}),"\n",(0,t.jsx)(a.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts#L28",children:"packages/mongodb-chatbot-evaluation/src/CommandMetadataStore.ts:28"})})]})}function m(e={}){const{wrapper:a}={...(0,o.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},11151:(e,a,n)=>{n.d(a,{Z:()=>s,a:()=>i});var t=n(67294);const o={},r=t.createContext(o);function i(e){const a=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function s(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(r.Provider,{value:a},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f6f48b5e.147235b6.js b/assets/js/f6f48b5e.147235b6.js
new file mode 100644
index 000000000..9cabd1744
--- /dev/null
+++ b/assets/js/f6f48b5e.147235b6.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8917],{181:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var a=t(85893),i=t(11151);const s={id:"ConversationEvalData",title:"Interface: ConversationEvalData",sidebar_label:"ConversationEvalData",sidebar_position:0,custom_edit_url:null},r=void 0,o={id:"reference/evaluation/interfaces/ConversationEvalData",title:"Interface: ConversationEvalData",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/ConversationEvalData.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/ConversationEvalData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationEvalData",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationEvalData",title:"Interface: ConversationEvalData",sidebar_label:"ConversationEvalData",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata"},next:{title:"ConversationGeneratedData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationGeneratedData"}},c={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"expectedLinks",id:"expectedlinks",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"qualitativeFinalAssistantMessageExpectation",id:"qualitativefinalassistantmessageexpectation",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tags",id:"tags",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",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["\u21b3 ",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"ConversationEvalData"})})]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(n.h3,{id:"expectedlinks",children:"expectedLinks"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"expectedLinks"}),": ",(0,a.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,a.jsx)(n.p,{children:"Link segments expected to be included in the final assistant message."}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L39",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:39"})}),"\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.p,{children:"Description of what the test case assesses."}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L34",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:34"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"qualitativefinalassistantmessageexpectation",children:"qualitativeFinalAssistantMessageExpectation"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"qualitativeFinalAssistantMessageExpectation"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"Description of what you want to see from the final assistant message.\nAn LLM can use this description to see if the final assistant message meets this expectation."}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:29"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"tags",children:"tags"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"tags"}),": ",(0,a.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,a.jsx)(n.p,{children:"Arbitrary metadata about the conversation."}),"\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/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:23"})})]})}function h(e={}){const{wrapper:n}={...(0,i.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:()=>o,a:()=>r});var a=t(67294);const i={},s=a.createContext(i);function r(e){const n=a.useContext(s);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:r(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f6f48b5e.f38ac531.js b/assets/js/f6f48b5e.f38ac531.js
deleted file mode 100644
index 7e63e71ae..000000000
--- a/assets/js/f6f48b5e.f38ac531.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8917],{181:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var a=t(85893),i=t(11151);const s={id:"ConversationEvalData",title:"Interface: ConversationEvalData",sidebar_label:"ConversationEvalData",sidebar_position:0,custom_edit_url:null},r=void 0,o={id:"reference/evaluation/interfaces/ConversationEvalData",title:"Interface: ConversationEvalData",description:"Hierarchy",source:"@site/docs/reference/evaluation/interfaces/ConversationEvalData.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/ConversationEvalData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationEvalData",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ConversationEvalData",title:"Interface: ConversationEvalData",sidebar_label:"ConversationEvalData",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"CommandRunMetadata",permalink:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata"},next:{title:"ConversationGeneratedData",permalink:"/chatbot/reference/evaluation/interfaces/ConversationGeneratedData"}},c={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"qualitativeFinalAssistantMessageExpectation",id:"qualitativefinalassistantmessageexpectation",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"tags",id:"tags",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",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["\u21b3 ",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"ConversationEvalData"})})]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.p,{children:"Description of what the test case assesses."}),"\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/generate/GeneratedDataStore.ts#L34",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:34"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"qualitativefinalassistantmessageexpectation",children:"qualitativeFinalAssistantMessageExpectation"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"qualitativeFinalAssistantMessageExpectation"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"Description of what you want to see from the final assistant message.\nAn LLM can use this description to see if the final assistant message meets this expectation."}),"\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/generate/GeneratedDataStore.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:29"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h3,{id:"tags",children:"tags"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.code,{children:"Optional"})," ",(0,a.jsx)(n.strong,{children:"tags"}),": ",(0,a.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,a.jsx)(n.p,{children:"Arbitrary metadata about the conversation."}),"\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/generate/GeneratedDataStore.ts#L23",children:"packages/mongodb-chatbot-evaluation/src/generate/GeneratedDataStore.ts:23"})})]})}function h(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:()=>o,a:()=>r});var a=t(67294);const i={},s=a.createContext(i);function r(e){const n=a.useContext(s);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:r(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/fbabf8d9.ca7d421d.js b/assets/js/fbabf8d9.56a563bd.js
similarity index 85%
rename from assets/js/fbabf8d9.ca7d421d.js
rename to assets/js/fbabf8d9.56a563bd.js
index e7a3db3e8..6ea13a5a7 100644
--- a/assets/js/fbabf8d9.ca7d421d.js
+++ b/assets/js/fbabf8d9.56a563bd.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2328],{31334:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=r(85893),s=r(11151);const t={id:"AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",sidebar_label:"AzureOpenAiServiceConfig",sidebar_position:0,custom_edit_url:null},c=void 0,o={id:"reference/core/interfaces/AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",description:"Properties",source:"@site/docs/reference/core/interfaces/AzureOpenAiServiceConfig.md",sourceDirName:"reference/core/interfaces",slug:"/reference/core/interfaces/AzureOpenAiServiceConfig",permalink:"/chatbot/reference/core/interfaces/AzureOpenAiServiceConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",sidebar_label:"AzureOpenAiServiceConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Exports",permalink:"/chatbot/reference/core/modules"},next:{title:"EmbeddedContent",permalink:"/chatbot/reference/core/interfaces/EmbeddedContent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"baseUrl",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"deployment",id:"deployment",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"version",id:"version",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,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apikey",children:"apiKey"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"apiKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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-rag-core/src/TypeChatJsonTranslateFunc.ts#L5",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:5"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"baseurl",children:"baseUrl"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"baseUrl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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-rag-core/src/TypeChatJsonTranslateFunc.ts#L6",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:6"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deployment",children:"deployment"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"deployment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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-rag-core/src/TypeChatJsonTranslateFunc.ts#L7",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:7"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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-rag-core/src/TypeChatJsonTranslateFunc.ts#L8",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:8"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var i=r(67294);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);return i.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(s):e.components||s:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2328],{31334:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=r(85893),s=r(11151);const t={id:"AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",sidebar_label:"AzureOpenAiServiceConfig",sidebar_position:0,custom_edit_url:null},o=void 0,c={id:"reference/core/interfaces/AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",description:"Properties",source:"@site/docs/reference/core/interfaces/AzureOpenAiServiceConfig.md",sourceDirName:"reference/core/interfaces",slug:"/reference/core/interfaces/AzureOpenAiServiceConfig",permalink:"/chatbot/reference/core/interfaces/AzureOpenAiServiceConfig",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AzureOpenAiServiceConfig",title:"Interface: AzureOpenAiServiceConfig",sidebar_label:"AzureOpenAiServiceConfig",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"Exports",permalink:"/chatbot/reference/core/modules"},next:{title:"EmbeddedContent",permalink:"/chatbot/reference/core/interfaces/EmbeddedContent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"apiKey",id:"apikey",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"baseUrl",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"deployment",id:"deployment",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"version",id:"version",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,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apikey",children:"apiKey"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"apiKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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/1b3e54e/packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts#L5",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:5"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"baseurl",children:"baseUrl"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"baseUrl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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/1b3e54e/packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts#L6",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:6"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deployment",children:"deployment"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"deployment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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/1b3e54e/packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts#L7",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:7"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\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/1b3e54e/packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts#L8",children:"packages/mongodb-rag-core/src/TypeChatJsonTranslateFunc.ts:8"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},11151:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(67294);const s={},t=i.createContext(s);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/fe605128.a5246c44.js b/assets/js/fe605128.a5246c44.js
new file mode 100644
index 000000000..266677425
--- /dev/null
+++ b/assets/js/fe605128.a5246c44.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5324],{22609:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>c});var n=t(85893),r=t(11151);const d={id:"GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",sidebar_label:"GenerateDataAndMetadataParams",sidebar_position:0,custom_edit_url:null},s=void 0,i={id:"reference/evaluation/interfaces/GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/GenerateDataAndMetadataParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/GenerateDataAndMetadataParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",sidebar_label:"GenerateDataAndMetadataParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"ExpectedLinks",permalink:"/chatbot/reference/evaluation/interfaces/ExpectedLinks"},next:{title:"GenerateDataFuncParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"generatedDataStore",id:"generateddatastore",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"generator",id:"generator",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadataStore",id:"metadatastore",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:"testCases",id:"testcases",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const a={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(a.h3,{id:"generateddatastore",children:"generatedDataStore"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"generatedDataStore"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",children:(0,n.jsx)(a.code,{children:"GeneratedDataStore"})})]}),"\n",(0,n.jsx)(a.p,{children:"Store for generated data."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:29"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"generator",children:"generator"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"generator"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/modules#generatedatafunc",children:(0,n.jsx)(a.code,{children:"GenerateDataFunc"})})]}),"\n",(0,n.jsx)(a.p,{children:"Function to generate data from test cases."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:24"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"metadatastore",children:"metadataStore"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"metadataStore"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",children:(0,n.jsx)(a.code,{children:"CommandMetadataStore"})})]}),"\n",(0,n.jsx)(a.p,{children:"Store for command metadata."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L34",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:34"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"name"}),": ",(0,n.jsx)(a.code,{children:"string"})]}),"\n",(0,n.jsx)(a.p,{children:"Name of the command that generated the data."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L19",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:19"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"testcases",children:"testCases"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"testCases"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/modules#sometestcase",children:(0,n.jsx)(a.code,{children:"SomeTestCase"})}),"[]"]}),"\n",(0,n.jsx)(a.p,{children:"Test cases to generate data from."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L14",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:14"})})]})}function h(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},11151:(e,a,t)=>{t.d(a,{Z:()=>i,a:()=>s});var n=t(67294);const r={},d=n.createContext(r);function s(e){const a=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(d.Provider,{value:a},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/fe605128.fcd7f983.js b/assets/js/fe605128.fcd7f983.js
deleted file mode 100644
index 49020dbb7..000000000
--- a/assets/js/fe605128.fcd7f983.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5324],{22609:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>c});var n=t(85893),r=t(11151);const d={id:"GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",sidebar_label:"GenerateDataAndMetadataParams",sidebar_position:0,custom_edit_url:null},s=void 0,i={id:"reference/evaluation/interfaces/GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",description:"Properties",source:"@site/docs/reference/evaluation/interfaces/GenerateDataAndMetadataParams.md",sourceDirName:"reference/evaluation/interfaces",slug:"/reference/evaluation/interfaces/GenerateDataAndMetadataParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"GenerateDataAndMetadataParams",title:"Interface: GenerateDataAndMetadataParams",sidebar_label:"GenerateDataAndMetadataParams",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"EvaluationStore",permalink:"/chatbot/reference/evaluation/interfaces/EvaluationStore"},next:{title:"GenerateDataFuncParams",permalink:"/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"generatedDataStore",id:"generateddatastore",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"generator",id:"generator",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"metadataStore",id:"metadatastore",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:"testCases",id:"testcases",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const a={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(a.h3,{id:"generateddatastore",children:"generatedDataStore"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"generatedDataStore"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",children:(0,n.jsx)(a.code,{children:"GeneratedDataStore"})})]}),"\n",(0,n.jsx)(a.p,{children:"Store for generated data."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L29",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:29"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"generator",children:"generator"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"generator"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/modules#generatedatafunc",children:(0,n.jsx)(a.code,{children:"GenerateDataFunc"})})]}),"\n",(0,n.jsx)(a.p,{children:"Function to generate data from test cases."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L24",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:24"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"metadatastore",children:"metadataStore"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"metadataStore"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",children:(0,n.jsx)(a.code,{children:"CommandMetadataStore"})})]}),"\n",(0,n.jsx)(a.p,{children:"Store for command metadata."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L34",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:34"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"name"}),": ",(0,n.jsx)(a.code,{children:"string"})]}),"\n",(0,n.jsx)(a.p,{children:"Name of the command that generated the data."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L19",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:19"})}),"\n",(0,n.jsx)(a.hr,{}),"\n",(0,n.jsx)(a.h3,{id:"testcases",children:"testCases"}),"\n",(0,n.jsxs)(a.p,{children:["\u2022 ",(0,n.jsx)(a.strong,{children:"testCases"}),": ",(0,n.jsx)(a.a,{href:"/chatbot/reference/evaluation/modules#sometestcase",children:(0,n.jsx)(a.code,{children:"SomeTestCase"})}),"[]"]}),"\n",(0,n.jsx)(a.p,{children:"Test cases to generate data from."}),"\n",(0,n.jsx)(a.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(a.p,{children:(0,n.jsx)(a.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts#L14",children:"packages/mongodb-chatbot-evaluation/src/generate/generateDataAndMetadata.ts:14"})})]})}function h(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},11151:(e,a,t)=>{t.d(a,{Z:()=>i,a:()=>s});var n=t(67294);const r={},d=n.createContext(r);function s(e){const a=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(d.Provider,{value:a},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/fef834fc.81ccd7ef.js b/assets/js/fef834fc.766f51dc.js
similarity index 97%
rename from assets/js/fef834fc.81ccd7ef.js
rename to assets/js/fef834fc.766f51dc.js
index 388929f11..d223df308 100644
--- a/assets/js/fef834fc.81ccd7ef.js
+++ b/assets/js/fef834fc.766f51dc.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7435],{72479:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>x,frontMatter:()=>l,metadata:()=>i,toc:()=>h});var d=t(85893),s=t(11151);const l={id:"embed",title:"Module: embed",sidebar_label:"embed",sidebar_position:0,custom_edit_url:null},r=void 0,i={id:"reference/ingest/modules/embed",title:"Module: embed",description:"Type Aliases",source:"@site/docs/reference/ingest/modules/embed.md",sourceDirName:"reference/ingest/modules",slug:"/reference/ingest/modules/embed",permalink:"/chatbot/reference/ingest/modules/embed",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"embed",title:"Module: embed",sidebar_label:"embed",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"index",permalink:"/chatbot/reference/ingest/modules/"},next:{title:"sources",permalink:"/chatbot/reference/ingest/modules/sources"}},c={},h=[{value:"Type Aliases",id:"type-aliases",level:2},{value:"ChunkFunc",id:"chunkfunc",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"ChunkMetadataGetter",id:"chunkmetadatagetter",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"ChunkOptions",id:"chunkoptions",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"ChunkTransformer",id:"chunktransformer",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"ContentChunk",id:"contentchunk",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"SomeTokenizer",id:"sometokenizer",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Variables",id:"variables",level:2},{value:"defaultOpenApiSpecYamlChunkOptions",id:"defaultopenapispecyamlchunkoptions",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Functions",id:"functions",level:2},{value:"chunkMd",id:"chunkmd",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"chunkOpenApiSpecYaml",id:"chunkopenapispecyaml",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"chunkPage",id:"chunkpage",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"makeChunkFrontMatterUpdater",id:"makechunkfrontmatterupdater",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"standardChunkFrontMatterUpdater",id:"standardchunkfrontmatterupdater",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"standardMetadataGetter",id:"standardmetadatagetter",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"updateEmbeddedContent",id:"updateembeddedcontent",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"updateEmbeddedContentForPage",id:"updateembeddedcontentforpage",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,d.jsx)(n.h3,{id:"chunkfunc",children:"ChunkFunc"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkFunc"}),": (",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),": ",(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkmetadatagetter",children:"ChunkMetadataGetter"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkMetadataGetter"}),"<",(0,d.jsx)(n.code,{children:"T"}),">: (",(0,d.jsx)(n.code,{children:"args"}),": { ",(0,d.jsx)(n.code,{children:"chunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),"> ; ",(0,d.jsx)(n.code,{children:"metadata?"}),": ",(0,d.jsx)(n.code,{children:"T"})," ; ",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"})," ; ",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"})," }) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),"> = ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"args"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Previous metadata, if any. Omitting this from the return value should not overwrite previous metadata."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.text"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"The text of the chunk without metadata."})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L13",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:13"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkoptions",children:"ChunkOptions"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkOptions"}),": ",(0,d.jsx)(n.code,{children:"Object"})]}),"\n",(0,d.jsxs)(n.p,{children:["Options for converting a ",(0,d.jsx)(n.code,{children:"Page"})," into ",(0,d.jsx)(n.code,{children:"ContentChunk[]"}),"."]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-2",children:"Type declaration"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunkOverlap"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Number of tokens to overlap between chunks. If this is 0, chunks will not overlap. If this is greater than 0, chunks will overlap by this number of tokens."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"maxChunkSize"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Maximum chunk size before transform function is applied to it. If Page has more tokens than this number, it is split into smaller chunks."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"minChunkSize?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["Minimum chunk size before transform function is applied to it. If a chunk has fewer tokens than this number, it is discarded before ingestion. You can use this as a vector search optimization to avoid including chunks with very few tokens and thus very little semantic meaning. ",(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"Example"})})," You might set this to ",(0,d.jsx)(n.code,{children:"15"})," to avoid including chunks that are just a few characters or words. For instance, you likely would not want to set a chunk that is just the closing of a code block (",(0,d.jsx)(n.code,{children:"), which occurs not infrequently if chunking using the Langchain RecursiveCharacterTextSplitter. Chunk 1: ````text "}),'py foo = "bar" # more semantically relevant python code... ',(0,d.jsx)(n.code,{children:"Chunk 2:"}),"text ``` ````"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"tokenizer"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#sometokenizer",children:(0,d.jsx)(n.code,{children:"SomeTokenizer"})})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Tokenizer to use to count number of tokens in text."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"transform?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Transform to be applied to each chunk as it is produced. Provides the opportunity to prepend metadata, etc."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"yamlChunkSize?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"If provided, this will override the maxChunkSize for openapi-yaml pages. This is useful because openapi-yaml pages tend to be very large, and we want to split them into smaller chunks than the default maxChunkSize."})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L20",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:20"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunktransformer",children:"ChunkTransformer"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkTransformer"}),": (",(0,d.jsx)(n.code,{children:"chunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">, ",(0,d.jsx)(n.code,{children:"details"}),": { ",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"})," }) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-3",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"chunk"}),", ",(0,d.jsx)(n.code,{children:"details"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L6",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:6"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"contentchunk",children:"ContentChunk"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ContentChunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.code,{children:"EmbeddedContent"}),", ",(0,d.jsx)(n.code,{children:'"embedding"'})," | ",(0,d.jsx)(n.code,{children:'"updated"'}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L7",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:7"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"sometokenizer",children:"SomeTokenizer"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"SomeTokenizer"}),": ",(0,d.jsx)(n.code,{children:"Object"})]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-4",children:"Type declaration"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"encode"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"}),") => { ",(0,d.jsx)(n.code,{children:"bpe"}),": ",(0,d.jsx)(n.code,{children:"number"}),"[] ; ",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L80",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:80"})}),"\n",(0,d.jsx)(n.h2,{id:"variables",children:"Variables"}),"\n",(0,d.jsx)(n.h3,{id:"defaultopenapispecyamlchunkoptions",children:"defaultOpenApiSpecYamlChunkOptions"}),"\n",(0,d.jsxs)(n.p,{children:["\u2022 ",(0,d.jsx)(n.code,{children:"Const"})," ",(0,d.jsx)(n.strong,{children:"defaultOpenApiSpecYamlChunkOptions"}),": ",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkOpenApiSpecYaml.ts#L13",children:"mongodb-rag-ingest/src/embed/chunkOpenApiSpecYaml.ts:13"})}),"\n",(0,d.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,d.jsx)(n.h3,{id:"chunkmd",children:"chunkMd"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkMd"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkopenapispecyaml",children:"chunkOpenApiSpecYaml"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkOpenApiSpecYaml"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkpage",children:"chunkPage"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkPage"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"Returns chunked of a content page."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"makechunkfrontmatterupdater",children:"makeChunkFrontMatterUpdater"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"makeChunkFrontMatterUpdater"}),"<",(0,d.jsx)(n.code,{children:"T"}),">(",(0,d.jsx)(n.code,{children:"getMetadata"}),"): ",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})]}),"\n",(0,d.jsx)(n.p,{children:"Create a function that adds or updates front matter metadata to the chunk\ntext."}),"\n",(0,d.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),"> = ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"getMetadata"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkmetadatagetter",children:(0,d.jsx)(n.code,{children:"ChunkMetadataGetter"})}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L36",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:36"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"standardchunkfrontmatterupdater",children:"standardChunkFrontMatterUpdater"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"standardChunkFrontMatterUpdater"}),"(",(0,d.jsx)(n.code,{children:"chunk"}),", ",(0,d.jsx)(n.code,{children:"details"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L6",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:6"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"standardmetadatagetter",children:"standardMetadataGetter"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"standardMetadataGetter"}),"(",(0,d.jsx)(n.code,{children:"args"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<{ ",(0,d.jsx)(n.code,{children:"[k: string]"}),": ",(0,d.jsx)(n.code,{children:"unknown"}),"; ",(0,d.jsx)(n.code,{children:"codeBlockLanguages?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] ; ",(0,d.jsx)(n.code,{children:"hasCodeBlock"}),": ",(0,d.jsx)(n.code,{children:"boolean"})," ; ",(0,d.jsx)(n.code,{children:"pageTitle?"}),": ",(0,d.jsx)(n.code,{children:"string"})," ; ",(0,d.jsx)(n.code,{children:"tags?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }>"]}),"\n",(0,d.jsx)(n.p,{children:"Forms common metadata based on the chunk text, including info about any code\nexamples in the text."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Previous metadata, if any. Omitting this from the return value should not overwrite previous metadata."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.codeBlockLanguages?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.hasCodeBlock"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.pageTitle?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.tags?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.text"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"The text of the chunk without metadata."})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<{ ",(0,d.jsx)(n.code,{children:"[k: string]"}),": ",(0,d.jsx)(n.code,{children:"unknown"}),"; ",(0,d.jsx)(n.code,{children:"codeBlockLanguages?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] ; ",(0,d.jsx)(n.code,{children:"hasCodeBlock"}),": ",(0,d.jsx)(n.code,{children:"boolean"})," ; ",(0,d.jsx)(n.code,{children:"pageTitle?"}),": ",(0,d.jsx)(n.code,{children:"string"})," ; ",(0,d.jsx)(n.code,{children:"tags?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L15",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:15"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"updateembeddedcontent",children:"updateEmbeddedContent"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"updateEmbeddedContent"}),"(",(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.p,{children:"(Re-)embeddedContent the pages in the page store that have changed since the given date\nand stores the embeddedContent in the embeddedContent store."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"chunkOptions?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embeddedContentStore"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"EmbeddedContentStore"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embedder"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Embedder"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"pageStore"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"PageStore"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"since"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Date"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"sourceNames?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts#L16",children:"mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts:16"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"updateembeddedcontentforpage",children:"updateEmbeddedContentForPage"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"updateEmbeddedContentForPage"}),"(",(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"chunkOptions?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embedder"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Embedder"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"page"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"PersistedPage"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"store"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"EmbeddedContentStore"})})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/f43cc5d/packages/mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts#L77",children:"mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts:77"})})]})}function x(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>r});var d=t(67294);const s={},l=d.createContext(s);function r(e){const n=d.useContext(l);return d.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),d.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7435],{72479:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>x,frontMatter:()=>l,metadata:()=>i,toc:()=>h});var d=t(85893),s=t(11151);const l={id:"embed",title:"Module: embed",sidebar_label:"embed",sidebar_position:0,custom_edit_url:null},r=void 0,i={id:"reference/ingest/modules/embed",title:"Module: embed",description:"Type Aliases",source:"@site/docs/reference/ingest/modules/embed.md",sourceDirName:"reference/ingest/modules",slug:"/reference/ingest/modules/embed",permalink:"/chatbot/reference/ingest/modules/embed",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"embed",title:"Module: embed",sidebar_label:"embed",sidebar_position:0,custom_edit_url:null},sidebar:"main",previous:{title:"index",permalink:"/chatbot/reference/ingest/modules/"},next:{title:"sources",permalink:"/chatbot/reference/ingest/modules/sources"}},c={},h=[{value:"Type Aliases",id:"type-aliases",level:2},{value:"ChunkFunc",id:"chunkfunc",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"ChunkMetadataGetter",id:"chunkmetadatagetter",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"ChunkOptions",id:"chunkoptions",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"ChunkTransformer",id:"chunktransformer",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"ContentChunk",id:"contentchunk",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"SomeTokenizer",id:"sometokenizer",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Variables",id:"variables",level:2},{value:"defaultOpenApiSpecYamlChunkOptions",id:"defaultopenapispecyamlchunkoptions",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Functions",id:"functions",level:2},{value:"chunkMd",id:"chunkmd",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"chunkOpenApiSpecYaml",id:"chunkopenapispecyaml",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"chunkPage",id:"chunkpage",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"makeChunkFrontMatterUpdater",id:"makechunkfrontmatterupdater",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"standardChunkFrontMatterUpdater",id:"standardchunkfrontmatterupdater",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"standardMetadataGetter",id:"standardmetadatagetter",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"updateEmbeddedContent",id:"updateembeddedcontent",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"updateEmbeddedContentForPage",id:"updateembeddedcontentforpage",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,d.jsx)(n.h3,{id:"chunkfunc",children:"ChunkFunc"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkFunc"}),": (",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),": ",(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkmetadatagetter",children:"ChunkMetadataGetter"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkMetadataGetter"}),"<",(0,d.jsx)(n.code,{children:"T"}),">: (",(0,d.jsx)(n.code,{children:"args"}),": { ",(0,d.jsx)(n.code,{children:"chunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),"> ; ",(0,d.jsx)(n.code,{children:"metadata?"}),": ",(0,d.jsx)(n.code,{children:"T"})," ; ",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"})," ; ",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"})," }) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),"> = ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"args"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Previous metadata, if any. Omitting this from the return value should not overwrite previous metadata."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.text"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"The text of the chunk without metadata."})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L13",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:13"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkoptions",children:"ChunkOptions"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkOptions"}),": ",(0,d.jsx)(n.code,{children:"Object"})]}),"\n",(0,d.jsxs)(n.p,{children:["Options for converting a ",(0,d.jsx)(n.code,{children:"Page"})," into ",(0,d.jsx)(n.code,{children:"ContentChunk[]"}),"."]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-2",children:"Type declaration"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunkOverlap"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Number of tokens to overlap between chunks. If this is 0, chunks will not overlap. If this is greater than 0, chunks will overlap by this number of tokens."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"maxChunkSize"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Maximum chunk size before transform function is applied to it. If Page has more tokens than this number, it is split into smaller chunks."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"minChunkSize?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["Minimum chunk size before transform function is applied to it. If a chunk has fewer tokens than this number, it is discarded before ingestion. You can use this as a vector search optimization to avoid including chunks with very few tokens and thus very little semantic meaning. ",(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"Example"})})," You might set this to ",(0,d.jsx)(n.code,{children:"15"})," to avoid including chunks that are just a few characters or words. For instance, you likely would not want to set a chunk that is just the closing of a code block (",(0,d.jsx)(n.code,{children:"), which occurs not infrequently if chunking using the Langchain RecursiveCharacterTextSplitter. Chunk 1: ````text "}),'py foo = "bar" # more semantically relevant python code... ',(0,d.jsx)(n.code,{children:"Chunk 2:"}),"text ``` ````"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"tokenizer"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#sometokenizer",children:(0,d.jsx)(n.code,{children:"SomeTokenizer"})})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Tokenizer to use to count number of tokens in text."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"transform?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Transform to be applied to each chunk as it is produced. Provides the opportunity to prepend metadata, etc."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"yamlChunkSize?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"If provided, this will override the maxChunkSize for openapi-yaml pages. This is useful because openapi-yaml pages tend to be very large, and we want to split them into smaller chunks than the default maxChunkSize."})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L20",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:20"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunktransformer",children:"ChunkTransformer"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ChunkTransformer"}),": (",(0,d.jsx)(n.code,{children:"chunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">, ",(0,d.jsx)(n.code,{children:"details"}),": { ",(0,d.jsx)(n.code,{children:"page"}),": ",(0,d.jsx)(n.code,{children:"Page"})," }) => ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-3",children:"Type declaration"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 (",(0,d.jsx)(n.code,{children:"chunk"}),", ",(0,d.jsx)(n.code,{children:"details"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]})]})]}),"\n",(0,d.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L6",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:6"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"contentchunk",children:"ContentChunk"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"ContentChunk"}),": ",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.code,{children:"EmbeddedContent"}),", ",(0,d.jsx)(n.code,{children:'"embedding"'})," | ",(0,d.jsx)(n.code,{children:'"updated"'}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L7",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:7"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"sometokenizer",children:"SomeTokenizer"}),"\n",(0,d.jsxs)(n.p,{children:["\u01ac ",(0,d.jsx)(n.strong,{children:"SomeTokenizer"}),": ",(0,d.jsx)(n.code,{children:"Object"})]}),"\n",(0,d.jsx)(n.h4,{id:"type-declaration-4",children:"Type declaration"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"encode"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"}),") => { ",(0,d.jsx)(n.code,{children:"bpe"}),": ",(0,d.jsx)(n.code,{children:"number"}),"[] ; ",(0,d.jsx)(n.code,{children:"text"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L80",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:80"})}),"\n",(0,d.jsx)(n.h2,{id:"variables",children:"Variables"}),"\n",(0,d.jsx)(n.h3,{id:"defaultopenapispecyamlchunkoptions",children:"defaultOpenApiSpecYamlChunkOptions"}),"\n",(0,d.jsxs)(n.p,{children:["\u2022 ",(0,d.jsx)(n.code,{children:"Const"})," ",(0,d.jsx)(n.strong,{children:"defaultOpenApiSpecYamlChunkOptions"}),": ",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkOpenApiSpecYaml.ts#L13",children:"mongodb-rag-ingest/src/embed/chunkOpenApiSpecYaml.ts:13"})}),"\n",(0,d.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,d.jsx)(n.h3,{id:"chunkmd",children:"chunkMd"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkMd"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkopenapispecyaml",children:"chunkOpenApiSpecYaml"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkOpenApiSpecYaml"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"A ChunkFunc is a function that takes a page and returns it in chunks."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"chunkpage",children:"chunkPage"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"chunkPage"}),"(",(0,d.jsx)(n.code,{children:"page"}),", ",(0,d.jsx)(n.code,{children:"options?"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.p,{children:"Returns chunked of a content page."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"options?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),"[]>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/chunkPage.ts#L12",children:"mongodb-rag-ingest/src/embed/chunkPage.ts:12"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"makechunkfrontmatterupdater",children:"makeChunkFrontMatterUpdater"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"makeChunkFrontMatterUpdater"}),"<",(0,d.jsx)(n.code,{children:"T"}),">(",(0,d.jsx)(n.code,{children:"getMetadata"}),"): ",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})]}),"\n",(0,d.jsx)(n.p,{children:"Create a function that adds or updates front matter metadata to the chunk\ntext."}),"\n",(0,d.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"T"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),"> = ",(0,d.jsx)(n.code,{children:"Record"}),"<",(0,d.jsx)(n.code,{children:"string"}),", ",(0,d.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"getMetadata"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkmetadatagetter",children:(0,d.jsx)(n.code,{children:"ChunkMetadataGetter"})}),"<",(0,d.jsx)(n.code,{children:"T"}),">"]})]})})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunktransformer",children:(0,d.jsx)(n.code,{children:"ChunkTransformer"})})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L36",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:36"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"standardchunkfrontmatterupdater",children:"standardChunkFrontMatterUpdater"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"standardChunkFrontMatterUpdater"}),"(",(0,d.jsx)(n.code,{children:"chunk"}),", ",(0,d.jsx)(n.code,{children:"details"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"details.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L6",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:6"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"standardmetadatagetter",children:"standardMetadataGetter"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"standardMetadataGetter"}),"(",(0,d.jsx)(n.code,{children:"args"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<{ ",(0,d.jsx)(n.code,{children:"[k: string]"}),": ",(0,d.jsx)(n.code,{children:"unknown"}),"; ",(0,d.jsx)(n.code,{children:"codeBlockLanguages?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] ; ",(0,d.jsx)(n.code,{children:"hasCodeBlock"}),": ",(0,d.jsx)(n.code,{children:"boolean"})," ; ",(0,d.jsx)(n.code,{children:"pageTitle?"}),": ",(0,d.jsx)(n.code,{children:"string"})," ; ",(0,d.jsx)(n.code,{children:"tags?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }>"]}),"\n",(0,d.jsx)(n.p,{children:"Forms common metadata based on the chunk text, including info about any code\nexamples in the text."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.chunk"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Omit"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#contentchunk",children:(0,d.jsx)(n.code,{children:"ContentChunk"})}),", ",(0,d.jsx)(n.code,{children:'"tokenCount"'}),">"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"Previous metadata, if any. Omitting this from the return value should not overwrite previous metadata."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.codeBlockLanguages?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.hasCodeBlock"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.pageTitle?"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.metadata.tags?"})}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Page"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"args.text"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:"The text of the chunk without metadata."})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<{ ",(0,d.jsx)(n.code,{children:"[k: string]"}),": ",(0,d.jsx)(n.code,{children:"unknown"}),"; ",(0,d.jsx)(n.code,{children:"codeBlockLanguages?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] ; ",(0,d.jsx)(n.code,{children:"hasCodeBlock"}),": ",(0,d.jsx)(n.code,{children:"boolean"})," ; ",(0,d.jsx)(n.code,{children:"pageTitle?"}),": ",(0,d.jsx)(n.code,{children:"string"})," ; ",(0,d.jsx)(n.code,{children:"tags?"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[] }>"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/ChunkTransformer.ts#L15",children:"mongodb-rag-ingest/src/embed/ChunkTransformer.ts:15"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"updateembeddedcontent",children:"updateEmbeddedContent"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"updateEmbeddedContent"}),"(",(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.p,{children:"(Re-)embeddedContent the pages in the page store that have changed since the given date\nand stores the embeddedContent in the embeddedContent store."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"chunkOptions?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embeddedContentStore"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"EmbeddedContentStore"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embedder"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Embedder"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"pageStore"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"PageStore"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"since"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Date"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"sourceNames?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"string"}),"[]"]})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts#L16",children:"mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts:16"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"updateembeddedcontentforpage",children:"updateEmbeddedContentForPage"}),"\n",(0,d.jsxs)(n.p,{children:["\u25b8 ",(0,d.jsx)(n.strong,{children:"updateEmbeddedContentForPage"}),"(",(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,d.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Object"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"chunkOptions?"})]}),(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,d.jsx)(n.code,{children:"Partial"}),"<",(0,d.jsx)(n.a,{href:"/chatbot/reference/ingest/modules/embed#chunkoptions",children:(0,d.jsx)(n.code,{children:"ChunkOptions"})}),">"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"embedder"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"Embedder"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"page"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"PersistedPage"})})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,d.jsx)(n.code,{children:"store"})]}),(0,d.jsx)(n.td,{style:{textAlign:"left"},children:(0,d.jsx)(n.code,{children:"EmbeddedContentStore"})})]})]})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Promise"}),"<",(0,d.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/mongodben/chatbot/blob/1b3e54e/packages/mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts#L77",children:"mongodb-rag-ingest/src/embed/updateEmbeddedContent.ts:77"})})]})}function x(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(o,{...e})}):o(e)}},11151:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>r});var d=t(67294);const s={},l=d.createContext(s);function r(e){const n=d.useContext(l);return d.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),d.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/main.2f39ec8a.js b/assets/js/main.2f39ec8a.js
new file mode 100644
index 000000000..ebb5b7762
--- /dev/null
+++ b/assets/js/main.2f39ec8a.js
@@ -0,0 +1,2 @@
+/*! For license information please see main.2f39ec8a.js.LICENSE.txt */
+(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});n(67294);var r=n(68356),a=n.n(r),o=n(16887);const i={"00126ca9":[()=>n.e(8086).then(n.bind(n,3230)),"@site/docs/reference/server/interfaces/ConversationConstants.md",3230],"00ed12f2":[()=>n.e(4113).then(n.bind(n,76992)),"@site/docs/reference/core/modules.md",76992],"04312b52":[()=>n.e(3885).then(n.bind(n,25710)),"@site/docs/reference/eval/interfaces/MongoDbEvaluationStore.md",25710],"04607c60":[()=>n.e(9412).then(n.bind(n,55034)),"@site/docs/reference/evaluation/interfaces/MakeGenerateLlmConversationDataParams.md",55034],"053515eb":[()=>n.e(378).then(n.bind(n,51428)),"@site/docs/reference/server/interfaces/CommentMessageParams.md",51428],"06cd8c03":[()=>n.e(6387).then(n.bind(n,1824)),"@site/docs/reference/server/interfaces/CallToolResponse.md",1824],"075a07c3":[()=>n.e(4788).then(n.bind(n,77502)),"@site/docs/reference/evaluation/interfaces/ReportEvalFuncParams.md",77502],"095cad7e":[()=>n.e(5745).then(n.bind(n,19790)),"@site/docs/reference/server/interfaces/FindByIdParams.md",19790],"09aec7c4":[()=>n.e(8904).then(n.bind(n,8468)),"@site/docs/reference/evaluation/interfaces/MongoDbEvaluationStore.md",8468],"0a965094":[()=>n.e(8030).then(n.bind(n,7291)),"@site/docs/reference/ingest/interfaces/sources.ProjectBase.md",7291],"0dc0950a":[()=>n.e(6321).then(n.bind(n,57018)),"@site/docs/ui.md",57018],"0e2fd017":[()=>n.e(8063).then(n.bind(n,39842)),"@site/docs/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams.md",39842],"0ff22746":[()=>n.e(8733).then(n.bind(n,60326)),"@site/docs/reference/evaluation/interfaces/EvalConfig.md",60326],"12495dd8":[()=>n.e(6242).then(n.bind(n,9530)),"@site/docs/server/conversations.md",9530],"1374c2dd":[()=>n.e(1665).then(n.bind(n,35382)),"@site/docs/evaluation/command-reference.md",35382],"14eb3368":[()=>Promise.all([n.e(532),n.e(9817)]).then(n.bind(n,34228)),"@theme/DocCategoryGeneratedIndexPage",34228],"16d7d47e":[()=>n.e(9763).then(n.bind(n,12189)),"@site/docs/reference/ingest/modules/sources.md",12189],17896441:[()=>Promise.all([n.e(532),n.e(7918)]).then(n.bind(n,10987)),"@theme/DocItem",10987],"19af0c64":[()=>n.e(1538).then(n.bind(n,80600)),"@site/docs/evaluation/index.md",80600],"1c129967":[()=>n.e(7597).then(n.bind(n,58006)),"@site/docs/server/llm.md",58006],"1ddf9523":[()=>n.e(3848).then(n.bind(n,19062)),"@site/docs/server/persist.md",19062],"1e7b863f":[()=>n.e(3201).then(n.bind(n,61117)),"@site/docs/reference/eval/interfaces/ConversationEvalData.md",61117],"211c52ba":[()=>n.e(4020).then(n.bind(n,72985)),"@site/docs/reference/eval/interfaces/EvaluateConversationQualityParams.md",72985],"217a4326":[()=>n.e(4195).then(n.bind(n,50024)),"@site/docs/reference/server/interfaces/ToolCallParams.md",50024],"21f447ab":[()=>n.e(1052).then(n.bind(n,31935)),"@site/docs/reference/ingest/interfaces/sources.SnootyProject.md",31935],"2352c6d6":[()=>n.e(8321).then(n.bind(n,48665)),"@site/docs/reference/server/interfaces/ConversationsRouterLocals.md",48665],"23fab249":[()=>n.e(6628).then(n.t.bind(n,83769,19)),"/Users/ben.p/projects/chatbot/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",83769],"25a9715c":[()=>n.e(9591).then(n.bind(n,87944)),"@site/docs/reference/eval/interfaces/EvaluationStore.md",87944],"29c2c5fe":[()=>n.e(8641).then(n.bind(n,44107)),"@site/docs/ingest/configuration-reference.md",44107],"2a14c161":[()=>n.e(9344).then(n.bind(n,79787)),"@site/docs/reference/evaluation/interfaces/MakeMongoDbReportStoreParams.md",79787],"2d7acbd3":[()=>n.e(9887).then(n.bind(n,35972)),"@site/docs/reference/eval/interfaces/EvalConfig.md",35972],"2db9a80b":[()=>n.e(8566).then(n.bind(n,35385)),"@site/docs/ingest/data-sources.md",35385],"2ef183da":[()=>n.e(8391).then(n.bind(n,59556)),"@site/docs/server/configure.md",59556],"2f54c1f7":[()=>n.e(8213).then(n.bind(n,37836)),"@site/docs/reference/eval/interfaces/GenerateDataFuncParams.md",37836],"34ee439d":[()=>n.e(9868).then(n.bind(n,23367)),"@site/docs/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams.md",23367],"37f76691":[()=>n.e(2357).then(n.bind(n,36128)),"@site/docs/reference/evaluation/interfaces/EvaluateConversationQualityParams.md",36128],"3965815d":[()=>n.e(3039).then(n.bind(n,42497)),"@site/docs/reference/eval/interfaces/MakeGenerateConversationDataParams.md",42497],"3bc6e262":[()=>n.e(36).then(n.bind(n,81874)),"@site/docs/reference/eval/modules.md",81874],"3eaab77f":[()=>n.e(6210).then(n.bind(n,9588)),"@site/docs/reference/server/index.md",9588],"3f30df8d":[()=>n.e(9991).then(n.bind(n,79583)),"@site/docs/reference/evaluation/interfaces/EvalResult.md",79583],"44c3951e":[()=>n.e(4125).then(n.bind(n,25659)),"@site/docs/reference/evaluation/interfaces/CheckResponseQuality.md",25659],"46ba77e2":[()=>n.e(7954).then(n.bind(n,10398)),"@site/docs/reference/server/interfaces/ChatLlm.md",10398],"47301a5f":[()=>n.e(9136).then(n.bind(n,32067)),"@site/docs/reference/ingest/interfaces/sources.Branch.md",32067],"49efd6ab":[()=>n.e(7475).then(n.bind(n,84041)),"@site/docs/server/rag/preprocess.md",84041],"4c053673":[()=>n.e(8753).then(n.bind(n,68367)),"@site/docs/reference/server/interfaces/AppConfig.md",68367],"4d856518":[()=>n.e(8202).then(n.t.bind(n,94704,19)),"~docs/default/category-chatbot-main-category-api-reference-146.json",94704],"4e9b4fcd":[()=>n.e(5302).then(n.bind(n,17594)),"@site/docs/reference/server/interfaces/GenerateUserPromptFuncReturnValue.md",17594],"4f272872":[()=>n.e(7058).then(n.bind(n,23771)),"@site/docs/reference/eval/interfaces/MakeMongoDbEvaluationStoreParams.md",23771],"4fddc917":[()=>n.e(2477).then(n.bind(n,12766)),"@site/docs/reference/evaluation/interfaces/CommandMetadataStore.md",12766],"51717f57":[()=>n.e(9776).then(n.bind(n,20686)),"@site/docs/reference/server/interfaces/EmbeddedContent.md",20686],"522e53fb":[()=>n.e(6887).then(n.bind(n,51)),"@site/docs/reference/server/interfaces/Tool.md",51],"52cccada":[()=>n.e(4625).then(n.bind(n,89751)),"@site/docs/reference/server/interfaces/ConversationsRateLimitConfig.md",89751],"558b764a":[()=>n.e(2622).then(n.bind(n,44685)),"@site/docs/reference/eval/interfaces/MakeMongoDbGeneratedDataStoreParams.md",44685],"59c4025c":[()=>n.e(5299).then(n.bind(n,45109)),"@site/docs/reference/evaluation/interfaces/CommandRunMetadata.md",45109],"5d73a134":[()=>n.e(2829).then(n.bind(n,5736)),"@site/docs/reference/eval/interfaces/BaseTestCase.md",5736],"5df701b8":[()=>n.e(8046).then(n.bind(n,42340)),"@site/docs/reference/eval/interfaces/ConversationGeneratedData.md",42340],"5e95c892":[()=>n.e(9661).then(n.bind(n,41892)),"@theme/DocsRoot",41892],"655a7d02":[()=>n.e(7882).then(n.bind(n,53344)),"@site/docs/reference/eval/interfaces/GenerateDataAndMetadataParams.md",53344],"68c95906":[()=>n.e(7988).then(n.bind(n,6101)),"@site/docs/reference/ingest/modules.md",6101],"6b7a1cdb":[()=>n.e(3820).then(n.bind(n,4578)),"@site/docs/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams.md",4578],"6c0ba004":[()=>n.e(3519).then(n.bind(n,80461)),"@site/docs/reference/evaluation/interfaces/EvaluationStore.md",80461],"6f2b505e":[()=>n.e(6274).then(n.bind(n,70750)),"@site/docs/ingest/command-reference.md",70750],"706742cd":[()=>n.e(6533).then(n.bind(n,7517)),"@site/docs/server/evaluate.md",7517],"70b5ccce":[()=>n.e(7929).then(n.bind(n,96474)),"@site/docs/reference/eval/interfaces/MakeMongoDbReportStoreParams.md",96474],"72e14192":[()=>n.e(7239).then(n.bind(n,54363)),"@site/docs/quick-start.md",54363],"73b44927":[()=>n.e(7083).then(n.bind(n,49550)),"@site/docs/reference/eval/interfaces/MongoDbGeneratedDataStore.md",49550],"770044b3":[()=>n.e(5658).then(n.bind(n,55939)),"@site/docs/reference/evaluation/interfaces/MakeGenerateConversationDataParams.md",55939],"7a721800":[()=>n.e(7626).then(n.bind(n,35625)),"@site/docs/reference/eval/interfaces/EvalResult.md",35625],"7b16a47f":[()=>n.e(8665).then(n.bind(n,20964)),"@site/docs/server/rag/references.md",20964],"7c21ef34":[()=>n.e(6173).then(n.bind(n,2705)),"@site/docs/reference/evaluation/interfaces/MongoDbGeneratedDataStore.md",2705],81770523:[()=>n.e(4352).then(n.bind(n,27534)),"@site/docs/reference/ingest/interfaces/sources.MakeGitDataSourceParams.md",27534],85320797:[()=>n.e(4835).then(n.bind(n,7323)),"@site/docs/reference/evaluation/interfaces/BaseGeneratedData.md",7323],"86e9bf51":[()=>n.e(9201).then(n.bind(n,79143)),"@site/docs/reference/server/interfaces/DataStreamer.md",79143],"88d96d71":[()=>n.e(6801).then(n.bind(n,53700)),"@site/docs/reference/eval/interfaces/CommandMetadataStore.md",53700],"8950b783":[()=>n.e(7801).then(n.bind(n,27832)),"@site/docs/reference/eval/interfaces/GeneratedDataStore.md",27832],"8a071b55":[()=>n.e(4470).then(n.bind(n,98107)),"@site/docs/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams.md",98107],"8a5452c6":[()=>n.e(7677).then(n.bind(n,83297)),"@site/docs/reference/evaluation/interfaces/GenerateDataFuncParams.md",83297],"8e875b0a":[()=>n.e(4561).then(n.t.bind(n,41837,19)),"/Users/ben.p/projects/chatbot/docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-0/redocApiSpecV1.2-plugin-redoc-0.json",41837],"9019bb38":[()=>n.e(9249).then(n.bind(n,48829)),"@site/docs/evaluation/pipeline.md",48829],"90a663a7":[()=>n.e(1269).then(n.bind(n,37162)),"@site/docs/reference/evaluation/interfaces/MongoDbReportStore.md",37162],"911a1996":[()=>n.e(2e3).then(n.bind(n,3901)),"@site/docs/reference/core/interfaces/EmbeddedContent.md",3901],"9295fd90":[()=>n.e(7323).then(n.bind(n,67479)),"@site/docs/reference/server/interfaces/MakeRagGenerateUserPromptParams.md",67479],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"94d04570":[()=>n.e(3329).then(n.bind(n,51889)),"@site/docs/reference/eval/interfaces/CheckResponseQualityParams.md",51889],"9d74c2e1":[()=>n.e(2214).then(n.bind(n,50837)),"@site/docs/reference/ingest/modules/index.md",50837],"9f213c28":[()=>n.e(8686).then(n.bind(n,82997)),"@site/docs/reference/server/modules.md",82997],"9f4e19d3":[()=>n.e(3084).then(n.bind(n,88390)),"@site/docs/reference/eval/interfaces/Report.md",88390],a0e92a93:[()=>n.e(4716).then(n.bind(n,35264)),"@site/docs/reference/eval/interfaces/MongoDbReportStore.md",35264],a17134cd:[()=>n.e(7945).then(n.bind(n,94583)),"@site/docs/ingest/optimize.md",94583],a219802b:[()=>n.e(7595).then(n.bind(n,73524)),"@site/docs/reference/evaluation/interfaces/BaseTestCase.md",73524],a2f28722:[()=>n.e(5373).then(n.bind(n,29282)),"@site/docs/reference/evaluation/interfaces/ExpectedLinks.md",29282],a3752608:[()=>n.e(7652).then(n.bind(n,74427)),"@site/docs/reference/eval/interfaces/ConversationTestCase.md",74427],a3ea6000:[()=>n.e(2539).then(n.bind(n,78951)),"@site/docs/reference/evaluation/interfaces/CheckResponseQualityParams.md",78951],a4b88ee3:[()=>n.e(7415).then(n.bind(n,67035)),"@site/docs/reference/evaluation/interfaces/Report.md",67035],a551f034:[()=>n.e(5843).then(n.bind(n,15622)),"@site/docs/reference/evaluation/interfaces/ReportStore.md",15622],a719d946:[()=>n.e(6227).then(n.t.bind(n,69162,19)),"/Users/ben.p/projects/chatbot/docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-0/plugin-route-context-module-100.json",69162],a77318db:[()=>n.e(8874).then(n.bind(n,1752)),"@site/docs/reference/eval/interfaces/CommandRunMetadata.md",1752],a7bd4aaa:[()=>n.e(8518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a84b57e7:[()=>n.e(5687).then(n.bind(n,86936)),"@site/docs/reference/server/interfaces/MakeLangchainChatLlmProps.md",86936],a8a2dfd7:[()=>n.e(5041).then(n.bind(n,29453)),"@site/docs/reference/eval/interfaces/CheckResponseQuality.md",29453],a9058ace:[()=>n.e(4138).then(n.bind(n,39983)),"@site/docs/reference/server/interfaces/RateMessageParams.md",39983],a94703ab:[()=>Promise.all([n.e(532),n.e(4368)]).then(n.bind(n,12674)),"@theme/DocRoot",12674],a94b3912:[()=>n.e(6268).then(n.bind(n,36125)),"@site/docs/reference/server/interfaces/Conversation.md",36125],aa81105c:[()=>n.e(9554).then(n.bind(n,49105)),"@site/docs/reference/server/interfaces/SearchBooster.md",49105],ac5b8ccc:[()=>n.e(1776).then(n.bind(n,9439)),"@site/docs/reference/server/interfaces/LlmCallToolParams.md",9439],b22bf373:[()=>n.e(9775).then(n.bind(n,21696)),"@site/docs/reference/ingest/interfaces/sources.MakeMongoDbUniversityDataSourceParams.md",21696],b6d883f0:[()=>n.e(805).then(n.bind(n,65583)),"@site/docs/reference/evaluation/interfaces/ConversationGeneratedData.md",65583],b98b7bfa:[()=>n.e(7394).then(n.bind(n,85248)),"@site/docs/server/custom-logic.md",85248],c377a04b:[()=>n.e(6971).then(n.bind(n,59925)),"@site/docs/index.md",59925],c7a1dce5:[()=>n.e(6960).then(n.bind(n,67813)),"@site/docs/reference/server/interfaces/LlmAnswerQuestionParams.md",67813],cdcc7979:[()=>n.e(9537).then(n.bind(n,94656)),"@site/docs/reference/eval/interfaces/ResponseQualityExample.md",94656],cecfba5b:[()=>n.e(5525).then(n.bind(n,77016)),"@site/docs/reference/evaluation/index.md",77016],ced61363:[()=>n.e(5042).then(n.bind(n,56378)),"@site/docs/reference/evaluation/modules.md",56378],d2778410:[()=>n.e(8959).then(n.bind(n,22466)),"@site/docs/reference/eval/interfaces/MakeMongoDbCommandMetadataStoreParams.md",22466],d2a2d3b7:[()=>n.e(1457).then(n.bind(n,90972)),"@site/docs/reference/evaluation/interfaces/ResponseQualityExample.md",90972],d377581f:[()=>n.e(5915).then(n.bind(n,17215)),"@site/docs/reference/eval/interfaces/BaseGeneratedData.md",17215],d404fa5f:[()=>n.e(4007).then(n.bind(n,51482)),"@site/docs/mongodb.md",51482],d4b5776c:[()=>n.e(3367).then(n.bind(n,63532)),"@site/docs/reference/ingest/interfaces/sources.DevCenterEntryTag.md",63532],d65f73bb:[()=>n.e(9349).then(n.bind(n,33535)),"@site/docs/reference/server/interfaces/MakeUserMessageFuncParams.md",33535],d67b0b72:[()=>n.e(9649).then(n.bind(n,69299)),"@site/docs/evaluation/configuration-reference.md",69299],d8792099:[()=>n.e(7423).then(n.bind(n,90374)),"@site/docs/reference/server/interfaces/ConversationsRouterParams.md",90374],d9cc7f9d:[()=>n.e(1264).then(n.bind(n,88514)),"@site/docs/reference/evaluation/interfaces/ConversationTestCase.md",88514],db7843ef:[()=>n.e(2287).then(n.t.bind(n,21294,19)),"/Users/ben.p/projects/chatbot/docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-0/redocApiLayoutV1-plugin-redoc-0.json",21294],dd24b439:[()=>n.e(7676).then(n.bind(n,10734)),"@site/docs/server/rag/index.md",10734],dd2e5366:[()=>n.e(8723).then(n.bind(n,84841)),"@site/docs/ingest/configure.md",84841],dd6b762f:[()=>n.e(2834).then(n.bind(n,12442)),"@site/docs/reference/evaluation/interfaces/GeneratedDataStore.md",12442],e3aa8d31:[()=>n.e(3965).then(n.bind(n,48130)),"@site/docs/reference/core/index.md",48130],e6673042:[()=>n.e(6816).then(n.bind(n,98207)),"@site/docs/reference/server/interfaces/MakeOpenAiChatLlmParams.md",98207],e6f5f3ec:[()=>n.e(7804).then(n.bind(n,22474)),"@site/docs/reference/ingest/index.md",22474],f0ad3fbb:[()=>Promise.all([n.e(532),n.e(5679),n.e(8612)]).then(n.bind(n,25679)),"@theme/ApiDoc",25679],f23362bf:[()=>n.e(2327).then(n.bind(n,70938)),"@site/docs/reference/eval/interfaces/ReportStore.md",70938],f29d94b6:[()=>n.e(4098).then(n.bind(n,35413)),"@site/docs/reference/server/interfaces/OpenAiChatMessage.md",35413],f4e3b7a1:[()=>n.e(2264).then(n.bind(n,63418)),"@site/docs/reference/server/interfaces/ConversationsService.md",63418],f5902fb6:[()=>n.e(4218).then(n.bind(n,99457)),"@site/docs/reference/server/interfaces/AzureOpenAiServiceConfig.md",99457],f5f59c64:[()=>n.e(6516).then(n.bind(n,24124)),"@site/docs/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams.md",24124],f6c33020:[()=>n.e(6694).then(n.bind(n,14632)),"@site/docs/server/rag/retrieve.md",14632],f6f48b5e:[()=>n.e(8917).then(n.bind(n,181)),"@site/docs/reference/evaluation/interfaces/ConversationEvalData.md",181],f92a24d7:[()=>n.e(5397).then(n.bind(n,28699)),"@site/docs/server/user-message.md",28699],fa6a8f36:[()=>n.e(5818).then(n.bind(n,66783)),"@site/docs/server/tools.md",66783],fbabf8d9:[()=>n.e(2328).then(n.bind(n,31334)),"@site/docs/reference/core/interfaces/AzureOpenAiServiceConfig.md",31334],fd0471b8:[()=>n.e(9442).then(n.bind(n,75384)),"@site/docs/reference/eval/index.md",75384],fe605128:[()=>n.e(5324).then(n.bind(n,22609)),"@site/docs/reference/evaluation/interfaces/GenerateDataAndMetadataParams.md",22609],fef834fc:[()=>n.e(7435).then(n.bind(n,72479)),"@site/docs/reference/ingest/modules/embed.md",72479]};var s=n(85893);function l(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(99670),u=n(30226);function d(e,t){if("*"===e)return a()({loading:l,loader:()=>n.e(1772).then(n.bind(n,51772)),modules:["@theme/NotFound"],webpack:()=>[51772],render(e,t){const n=e.default;return(0,s.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},f=[],p=[],m=(0,c.Z)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],f.push(r[1]),p.push(r[2]))})),a().Map({loading:l,loader:d,modules:f,webpack:()=>p,render(t,n){const a=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const o=r.default;if(!o)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof o&&"function"!=typeof o||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{o[e]=r[e]}));let i=a;const s=n.split(".");s.slice(0,-1).forEach((e=>{i=i[e]})),i[s[s.length-1]]=o}));const o=a.__comp;delete a.__comp;const i=a.__context;return delete a.__context,(0,s.jsx)(u.z,{value:i,children:(0,s.jsx)(o,{...a,...n})})}})}const f=[{path:"/chatbot/server/openapi/",component:d("/chatbot/server/openapi/","649"),exact:!0},{path:"/chatbot/",component:d("/chatbot/","2e8"),routes:[{path:"/chatbot/",component:d("/chatbot/","38f"),routes:[{path:"/chatbot/",component:d("/chatbot/","0b2"),routes:[{path:"/chatbot/evaluation/",component:d("/chatbot/evaluation/","c82"),exact:!0,sidebar:"main"},{path:"/chatbot/evaluation/command-reference",component:d("/chatbot/evaluation/command-reference","cd7"),exact:!0,sidebar:"main"},{path:"/chatbot/evaluation/configuration-reference",component:d("/chatbot/evaluation/configuration-reference","83a"),exact:!0,sidebar:"main"},{path:"/chatbot/evaluation/pipeline",component:d("/chatbot/evaluation/pipeline","ab8"),exact:!0,sidebar:"main"},{path:"/chatbot/ingest/command-reference",component:d("/chatbot/ingest/command-reference","bb8"),exact:!0,sidebar:"main"},{path:"/chatbot/ingest/configuration-reference",component:d("/chatbot/ingest/configuration-reference","5b8"),exact:!0,sidebar:"main"},{path:"/chatbot/ingest/configure",component:d("/chatbot/ingest/configure","92e"),exact:!0,sidebar:"main"},{path:"/chatbot/ingest/data-sources",component:d("/chatbot/ingest/data-sources","770"),exact:!0,sidebar:"main"},{path:"/chatbot/ingest/optimize",component:d("/chatbot/ingest/optimize","52b"),exact:!0,sidebar:"main"},{path:"/chatbot/mongodb",component:d("/chatbot/mongodb","da1"),exact:!0,sidebar:"main"},{path:"/chatbot/quick-start",component:d("/chatbot/quick-start","c0d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/",component:d("/chatbot/reference/","9a2"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/core/",component:d("/chatbot/reference/core/","d29"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/core/interfaces/AzureOpenAiServiceConfig",component:d("/chatbot/reference/core/interfaces/AzureOpenAiServiceConfig","73d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/core/interfaces/EmbeddedContent",component:d("/chatbot/reference/core/interfaces/EmbeddedContent","4e8"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/core/modules",component:d("/chatbot/reference/core/modules","82d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/eval/",component:d("/chatbot/reference/eval/","6d3"),exact:!0},{path:"/chatbot/reference/eval/interfaces/BaseGeneratedData",component:d("/chatbot/reference/eval/interfaces/BaseGeneratedData","4ed"),exact:!0},{path:"/chatbot/reference/eval/interfaces/BaseTestCase",component:d("/chatbot/reference/eval/interfaces/BaseTestCase","b60"),exact:!0},{path:"/chatbot/reference/eval/interfaces/CheckResponseQuality",component:d("/chatbot/reference/eval/interfaces/CheckResponseQuality","26d"),exact:!0},{path:"/chatbot/reference/eval/interfaces/CheckResponseQualityParams",component:d("/chatbot/reference/eval/interfaces/CheckResponseQualityParams","b92"),exact:!0},{path:"/chatbot/reference/eval/interfaces/CommandMetadataStore",component:d("/chatbot/reference/eval/interfaces/CommandMetadataStore","636"),exact:!0},{path:"/chatbot/reference/eval/interfaces/CommandRunMetadata",component:d("/chatbot/reference/eval/interfaces/CommandRunMetadata","b70"),exact:!0},{path:"/chatbot/reference/eval/interfaces/ConversationEvalData",component:d("/chatbot/reference/eval/interfaces/ConversationEvalData","800"),exact:!0},{path:"/chatbot/reference/eval/interfaces/ConversationGeneratedData",component:d("/chatbot/reference/eval/interfaces/ConversationGeneratedData","0e9"),exact:!0},{path:"/chatbot/reference/eval/interfaces/ConversationTestCase",component:d("/chatbot/reference/eval/interfaces/ConversationTestCase","458"),exact:!0},{path:"/chatbot/reference/eval/interfaces/EvalConfig",component:d("/chatbot/reference/eval/interfaces/EvalConfig","d33"),exact:!0},{path:"/chatbot/reference/eval/interfaces/EvalResult",component:d("/chatbot/reference/eval/interfaces/EvalResult","7ef"),exact:!0},{path:"/chatbot/reference/eval/interfaces/EvaluateConversationQualityParams",component:d("/chatbot/reference/eval/interfaces/EvaluateConversationQualityParams","850"),exact:!0},{path:"/chatbot/reference/eval/interfaces/EvaluationStore",component:d("/chatbot/reference/eval/interfaces/EvaluationStore","04c"),exact:!0},{path:"/chatbot/reference/eval/interfaces/GenerateDataAndMetadataParams",component:d("/chatbot/reference/eval/interfaces/GenerateDataAndMetadataParams","b79"),exact:!0},{path:"/chatbot/reference/eval/interfaces/GenerateDataFuncParams",component:d("/chatbot/reference/eval/interfaces/GenerateDataFuncParams","f85"),exact:!0},{path:"/chatbot/reference/eval/interfaces/GeneratedDataStore",component:d("/chatbot/reference/eval/interfaces/GeneratedDataStore","322"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MakeGenerateConversationDataParams",component:d("/chatbot/reference/eval/interfaces/MakeGenerateConversationDataParams","245"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MakeMongoDbCommandMetadataStoreParams",component:d("/chatbot/reference/eval/interfaces/MakeMongoDbCommandMetadataStoreParams","762"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MakeMongoDbEvaluationStoreParams",component:d("/chatbot/reference/eval/interfaces/MakeMongoDbEvaluationStoreParams","4ab"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MakeMongoDbGeneratedDataStoreParams",component:d("/chatbot/reference/eval/interfaces/MakeMongoDbGeneratedDataStoreParams","754"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MakeMongoDbReportStoreParams",component:d("/chatbot/reference/eval/interfaces/MakeMongoDbReportStoreParams","e77"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MongoDbEvaluationStore",component:d("/chatbot/reference/eval/interfaces/MongoDbEvaluationStore","d54"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MongoDbGeneratedDataStore",component:d("/chatbot/reference/eval/interfaces/MongoDbGeneratedDataStore","8cc"),exact:!0},{path:"/chatbot/reference/eval/interfaces/MongoDbReportStore",component:d("/chatbot/reference/eval/interfaces/MongoDbReportStore","b31"),exact:!0},{path:"/chatbot/reference/eval/interfaces/Report",component:d("/chatbot/reference/eval/interfaces/Report","1a0"),exact:!0},{path:"/chatbot/reference/eval/interfaces/ReportStore",component:d("/chatbot/reference/eval/interfaces/ReportStore","bc0"),exact:!0},{path:"/chatbot/reference/eval/interfaces/ResponseQualityExample",component:d("/chatbot/reference/eval/interfaces/ResponseQualityExample","2ad"),exact:!0},{path:"/chatbot/reference/eval/modules",component:d("/chatbot/reference/eval/modules","01a"),exact:!0},{path:"/chatbot/reference/evaluation/",component:d("/chatbot/reference/evaluation/","eb3"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/BaseGeneratedData",component:d("/chatbot/reference/evaluation/interfaces/BaseGeneratedData","953"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/BaseTestCase",component:d("/chatbot/reference/evaluation/interfaces/BaseTestCase","9a0"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/CheckResponseQuality",component:d("/chatbot/reference/evaluation/interfaces/CheckResponseQuality","81a"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams",component:d("/chatbot/reference/evaluation/interfaces/CheckResponseQualityParams","b75"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/CommandMetadataStore",component:d("/chatbot/reference/evaluation/interfaces/CommandMetadataStore","d40"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/CommandRunMetadata",component:d("/chatbot/reference/evaluation/interfaces/CommandRunMetadata","87c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ConversationEvalData",component:d("/chatbot/reference/evaluation/interfaces/ConversationEvalData","c32"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ConversationGeneratedData",component:d("/chatbot/reference/evaluation/interfaces/ConversationGeneratedData","35a"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ConversationTestCase",component:d("/chatbot/reference/evaluation/interfaces/ConversationTestCase","da1"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/EvalConfig",component:d("/chatbot/reference/evaluation/interfaces/EvalConfig","489"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/EvalResult",component:d("/chatbot/reference/evaluation/interfaces/EvalResult","8bf"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams",component:d("/chatbot/reference/evaluation/interfaces/EvaluateConversationQualityParams","38a"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/EvaluationStore",component:d("/chatbot/reference/evaluation/interfaces/EvaluationStore","4cb"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ExpectedLinks",component:d("/chatbot/reference/evaluation/interfaces/ExpectedLinks","9dc"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams",component:d("/chatbot/reference/evaluation/interfaces/GenerateDataAndMetadataParams","b69"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams",component:d("/chatbot/reference/evaluation/interfaces/GenerateDataFuncParams","bb0"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/GeneratedDataStore",component:d("/chatbot/reference/evaluation/interfaces/GeneratedDataStore","d42"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeGenerateConversationDataParams",component:d("/chatbot/reference/evaluation/interfaces/MakeGenerateConversationDataParams","a17"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeGenerateLlmConversationDataParams",component:d("/chatbot/reference/evaluation/interfaces/MakeGenerateLlmConversationDataParams","25b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams",component:d("/chatbot/reference/evaluation/interfaces/MakeMongoDbCommandMetadataStoreParams","78b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams",component:d("/chatbot/reference/evaluation/interfaces/MakeMongoDbEvaluationStoreParams","6f5"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams",component:d("/chatbot/reference/evaluation/interfaces/MakeMongoDbGeneratedDataStoreParams","a2f"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams",component:d("/chatbot/reference/evaluation/interfaces/MakeMongoDbReportStoreParams","b1b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore",component:d("/chatbot/reference/evaluation/interfaces/MongoDbEvaluationStore","06e"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MongoDbGeneratedDataStore",component:d("/chatbot/reference/evaluation/interfaces/MongoDbGeneratedDataStore","995"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/MongoDbReportStore",component:d("/chatbot/reference/evaluation/interfaces/MongoDbReportStore","82b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/Report",component:d("/chatbot/reference/evaluation/interfaces/Report","5d1"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ReportEvalFuncParams",component:d("/chatbot/reference/evaluation/interfaces/ReportEvalFuncParams","3ce"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ReportStore",component:d("/chatbot/reference/evaluation/interfaces/ReportStore","577"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/interfaces/ResponseQualityExample",component:d("/chatbot/reference/evaluation/interfaces/ResponseQualityExample","32d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/evaluation/modules",component:d("/chatbot/reference/evaluation/modules","d89"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/",component:d("/chatbot/reference/ingest/","e98"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.Branch",component:d("/chatbot/reference/ingest/interfaces/sources.Branch","ac1"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag",component:d("/chatbot/reference/ingest/interfaces/sources.DevCenterEntryTag","1db"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams",component:d("/chatbot/reference/ingest/interfaces/sources.MakeGitDataSourceParams","b87"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams",component:d("/chatbot/reference/ingest/interfaces/sources.MakeLangChainDocumentLoaderDataSourceParams","fba"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.MakeMongoDbUniversityDataSourceParams",component:d("/chatbot/reference/ingest/interfaces/sources.MakeMongoDbUniversityDataSourceParams","057"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.ProjectBase",component:d("/chatbot/reference/ingest/interfaces/sources.ProjectBase","0b2"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/interfaces/sources.SnootyProject",component:d("/chatbot/reference/ingest/interfaces/sources.SnootyProject","094"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/modules",component:d("/chatbot/reference/ingest/modules","9e8"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/modules/",component:d("/chatbot/reference/ingest/modules/","fad"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/modules/embed",component:d("/chatbot/reference/ingest/modules/embed","45a"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/ingest/modules/sources",component:d("/chatbot/reference/ingest/modules/sources","e78"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/",component:d("/chatbot/reference/server/","4b5"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/AppConfig",component:d("/chatbot/reference/server/interfaces/AppConfig","d0c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/AzureOpenAiServiceConfig",component:d("/chatbot/reference/server/interfaces/AzureOpenAiServiceConfig","69c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/CallToolResponse",component:d("/chatbot/reference/server/interfaces/CallToolResponse","e81"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ChatLlm",component:d("/chatbot/reference/server/interfaces/ChatLlm","a0f"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/CommentMessageParams",component:d("/chatbot/reference/server/interfaces/CommentMessageParams","c03"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/Conversation",component:d("/chatbot/reference/server/interfaces/Conversation","7bd"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ConversationConstants",component:d("/chatbot/reference/server/interfaces/ConversationConstants","ea8"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ConversationsRateLimitConfig",component:d("/chatbot/reference/server/interfaces/ConversationsRateLimitConfig","6f4"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ConversationsRouterLocals",component:d("/chatbot/reference/server/interfaces/ConversationsRouterLocals","586"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ConversationsRouterParams",component:d("/chatbot/reference/server/interfaces/ConversationsRouterParams","21c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ConversationsService",component:d("/chatbot/reference/server/interfaces/ConversationsService","8f4"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/DataStreamer",component:d("/chatbot/reference/server/interfaces/DataStreamer","f6d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/EmbeddedContent",component:d("/chatbot/reference/server/interfaces/EmbeddedContent","c9f"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/FindByIdParams",component:d("/chatbot/reference/server/interfaces/FindByIdParams","923"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/GenerateUserPromptFuncReturnValue",component:d("/chatbot/reference/server/interfaces/GenerateUserPromptFuncReturnValue","ed5"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/LlmAnswerQuestionParams",component:d("/chatbot/reference/server/interfaces/LlmAnswerQuestionParams","90d"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/LlmCallToolParams",component:d("/chatbot/reference/server/interfaces/LlmCallToolParams","313"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/MakeLangchainChatLlmProps",component:d("/chatbot/reference/server/interfaces/MakeLangchainChatLlmProps","919"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/MakeOpenAiChatLlmParams",component:d("/chatbot/reference/server/interfaces/MakeOpenAiChatLlmParams","d1b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/MakeRagGenerateUserPromptParams",component:d("/chatbot/reference/server/interfaces/MakeRagGenerateUserPromptParams","38c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/MakeUserMessageFuncParams",component:d("/chatbot/reference/server/interfaces/MakeUserMessageFuncParams","b8b"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams",component:d("/chatbot/reference/server/interfaces/MakeVerifiedAnswerGenerateUserPromptParams","41c"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/OpenAiChatMessage",component:d("/chatbot/reference/server/interfaces/OpenAiChatMessage","7bf"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/RateMessageParams",component:d("/chatbot/reference/server/interfaces/RateMessageParams","aa2"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/SearchBooster",component:d("/chatbot/reference/server/interfaces/SearchBooster","391"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/Tool",component:d("/chatbot/reference/server/interfaces/Tool","1a4"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/interfaces/ToolCallParams",component:d("/chatbot/reference/server/interfaces/ToolCallParams","319"),exact:!0,sidebar:"main"},{path:"/chatbot/reference/server/modules",component:d("/chatbot/reference/server/modules","f67"),exact:!0,sidebar:"main"},{path:"/chatbot/server/configure",component:d("/chatbot/server/configure","d8d"),exact:!0,sidebar:"main"},{path:"/chatbot/server/conversations",component:d("/chatbot/server/conversations","22b"),exact:!0,sidebar:"main"},{path:"/chatbot/server/custom-logic",component:d("/chatbot/server/custom-logic","6ae"),exact:!0,sidebar:"main"},{path:"/chatbot/server/evaluate",component:d("/chatbot/server/evaluate","58a"),exact:!0,sidebar:"main"},{path:"/chatbot/server/llm",component:d("/chatbot/server/llm","7c6"),exact:!0,sidebar:"main"},{path:"/chatbot/server/persist",component:d("/chatbot/server/persist","4e5"),exact:!0,sidebar:"main"},{path:"/chatbot/server/rag/",component:d("/chatbot/server/rag/","89c"),exact:!0,sidebar:"main"},{path:"/chatbot/server/rag/preprocess",component:d("/chatbot/server/rag/preprocess","0ed"),exact:!0,sidebar:"main"},{path:"/chatbot/server/rag/references",component:d("/chatbot/server/rag/references","33d"),exact:!0,sidebar:"main"},{path:"/chatbot/server/rag/retrieve",component:d("/chatbot/server/rag/retrieve","fbe"),exact:!0,sidebar:"main"},{path:"/chatbot/server/tools",component:d("/chatbot/server/tools","d38"),exact:!0,sidebar:"main"},{path:"/chatbot/server/user-message",component:d("/chatbot/server/user-message","c91"),exact:!0,sidebar:"main"},{path:"/chatbot/ui",component:d("/chatbot/ui","b12"),exact:!0,sidebar:"main"},{path:"/chatbot/",component:d("/chatbot/","277"),exact:!0,sidebar:"main"}]}]}]},{path:"*",component:d("*")}]},98934:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>i});var r=n(67294),a=n(85893);const o=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,a.jsx)(o.Provider,{value:n,children:t})}},97221:(e,t,n)=>{"use strict";var r=n(67294),a=n(20745),o=n(73727),i=n(70405),s=n(10412);const l=[n(32497),n(3310),n(18320),n(52295),n(41304),n(4750)];var c=n(723),u=n(16550),d=n(18790),f=n(85893);function p(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var m=n(35742),h=n(52263),g=n(44996),b=n(86668),v=n(1944),y=n(94711),w=n(19727),k=n(43320),x=n(18780),S=n(90197);function C(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,h.Z)(),r=(0,y.l)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,f.jsxs)(m.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function E(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,h.Z)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,g.Z)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,f.jsxs)(m.Z,{children:[(0,f.jsx)("meta",{property:"og:url",content:a}),(0,f.jsx)("link",{rel:"canonical",href:a})]})}function _(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,b.L)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(m.Z,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:w.h})]}),n&&(0,f.jsx)(v.d,{image:n}),(0,f.jsx)(E,{}),(0,f.jsx)(C,{}),(0,f.jsx)(S.Z,{tag:k.HX,locale:e}),(0,f.jsx)(m.Z,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const T=new Map;function P(e){if(T.has(e.pathname))return{...e,pathname:T.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}var R=n(98934),D=n(58940),M=n(20469);function A(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;rYour 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