{ "finalRelevantChunk": [ "Hello Pawa AI, I am the final relevant chunk you need" ], "filteredResults": [ { "id": 63, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "and for the whole period of staying in the Schengen area. In order to have a flexible travel schedule it is suggested to issue the Insurance for a few days longer than the planned travel time...", "distance": 0.7506968916261936 }, { "id": 76, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "plan agreed with the clinic. Medical health documentation issued by the applicant’s country of residence...", "distance": 0.7515738980069386 } ]}
{ "finalRelevantChunk": [ "Hello Pawa AI, I am the final relevant chunk you need" ], "filteredResults": [ { "id": 63, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "and for the whole period of staying in the Schengen area. In order to have a flexible travel schedule it is suggested to issue the Insurance for a few days longer than the planned travel time...", "distance": 0.7506968916261936 }, { "id": 76, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "plan agreed with the clinic. Medical health documentation issued by the applicant’s country of residence...", "distance": 0.7515738980069386 } ]}
The knowledge_base_reference_id of the knowledge base to perform the RAG if the question asked relates to the purpose of the knowledge_base_tool provided.
Filtered results based on the relevance of the chunks to the user query.
Show child attributes
Example:
[ { "id": 63, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "and for the whole period of staying in the Schengen area. In order to have a flexible travel schedule it is suggested to issue the Insurance for a few days longer than the planned travel time...", "distance": 0.7506968916261936 }, { "id": 76, "knowledgeBaseId": 7, "documentName": "131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf", "chunk": "plan agreed with the clinic. Medical health documentation issued by the applicant’s country of residence...", "distance": 0.7515738980069386 } ]
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Pawa AI Docs","colors":{"primary":"#FFA200","light":"#FFA200","dark":"#FFA200"},"logo":{"light":"https://mintcdn.com/sartifycoltd/ZmUMDiuhTZ-pD390/logo/pawa-logo-2.svg?fit=max\u0026auto=format\u0026n=ZmUMDiuhTZ-pD390\u0026q=85\u0026s=26ea97929a46ccbe6657a656b6447136","dark":"https://mintcdn.com/sartifycoltd/ZmUMDiuhTZ-pD390/logo/pawa-logo-2.svg?fit=max\u0026auto=format\u0026n=ZmUMDiuhTZ-pD390\u0026q=85\u0026s=26ea97929a46ccbe6657a656b6447136","href":"https://pawa-ai.com"},"favicon":"https://mintcdn.com/sartifycoltd/ZmUMDiuhTZ-pD390/favicon.svg?fit=max\u0026auto=format\u0026n=ZmUMDiuhTZ-pD390\u0026q=85\u0026s=ac15c194ae8d43ca1af971c0fcf9d7d4","navbar":{"links":[{"href":"https://api.whatsapp.com/send/?phone=255688067709\u0026text\u0026type=phone_number\u0026app_absent=0","label":"Get Support"}],"primary":{"type":"button","label":"Start Building","href":"https://builder.pawa-ai.com/dashboard"}},"footer":{"socials":{"website":"https://pawa-ai.com","github":"https://staging.pawa-ai.com/dev","linkedin":"https://staging.pawa-ai.com/dev"}},"fonts":{"family":"Nunito Sans"},"contextual":{"options":["copy","view","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"SandBox","icon":"play","href":"https://builder.pawa-ai.com/dashboard?page=sandbox"},{"anchor":"Get Your API Key","icon":"key","href":"https://builder.pawa-ai.com/dashboard?page=keys"},{"anchor":"Examples","icon":"github","href":"https://github.com/Sartify/pawa-ai-blueprints-chatbots"},{"anchor":"Blogs","icon":"book","href":"https://pawa-ai.com/blogs"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sartifycoltd","hasAudioNarration":false,"actualSubdomain":"sartifycoltd","customDomains":["docs.pawa-ai.com"],"gitSource":{"type":"github","owner":"sartify","repo":"pawa-ai-apis-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a8f7ba2b8432d5d8af2b235","collectionId":"76767dc3-f97d-4521-b29e-726ce4c04d73","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a8f7ba2b8432d5d8af2b235"},"entitlements":{},"buildId":"6a8f7ba2b8432d5d8af2b235","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Documentation","count":43},{"language":"default","tag":"API reference","count":41},{"language":"default","tag":"Capabilities","count":16},{"language":"default","tag":"Agents","count":13},{"language":"default","tag":"Transcribe","count":10},{"language":"default","tag":"Python SDK","count":10},{"language":"default","tag":"Getting Started","count":9},{"language":"default","tag":"Storage","count":8},{"language":"default","tag":"API","count":8},{"language":"default","tag":"Guides","count":6}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".h-6{height:2.5rem}.text-nowrap{display:none}.dark\\:bg-sky-500\\/10:is(.dark *){background-color:#000}.border-sky-500\\/20,.border-sky-500\\30 {border-color:#ffa200}.text-sky-500{--tw-text-opacity:1;color:#ffa200}.dark\\:border-sky-500\\/30:is(.dark *){border-color:#ffa200}.text-sky-900{color:#ffa200}.dark\\:text-sky-200 :is(.dark *){color:#ffa200}.max-w-xl{max-width:55rem}.dark\\:text-gray-400:is(.dark *){color:#afaeae}"}],"page":{"pagePath":"api-reference/endpoint/storage/knowledge-base/semantic-retrival","slug":"/api-reference/endpoint/storage/knowledge-base/semantic-retrival","pageMetadata":{"title":"Semantic Retrieval","openapi":"POST /store/knowledge-base/semantic-retrieval","description":"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.","href":"/api-reference/endpoint/storage/knowledge-base/semantic-retrival"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Semantic Retrieval","openapi":"POST /store/knowledge-base/semantic-retrieval","description":"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.","href":"/api-reference/endpoint/storage/knowledge-base/semantic-retrival"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.","requestBody":"81c434b2-515f-4559-9b29-3f7c177c96d6","responses":{"200":"8fc5df55-d5ac-4b87-886f-04dc15a9a9f9","400":"4061cc56-6ce7-4409-b49f-9ef6523c3cc3","401":"e3aa3431-0371-43de-b8fb-12ab54e1885e","403":"58c5602a-8478-42b7-8427-5ce8bd1badbc","404":"d59b5d30-6933-471e-bf55-963daa7028f7","429":"39933bbf-dd34-4cc5-82a5-b6d84cf02799","500":"98334d9d-099d-4a88-86aa-f0ab20763ee4"},"summary":"Knowledge base semantic retrieval","tags":["Knowledge base semantic retrieval"],"method":"post","type":"path","servers":["26023518-7cd4-4c5f-8208-7ffe0de21022"],"security":["5698ca4f-e7c7-48a5-b604-bfc0a680bf8f"],"path":"/store/knowledge-base/semantic-retrieval","baseUrlOptions":["https://api.pawa-ai.com/v1"],"title":"Knowledge base semantic retrieval","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"knowledge_base_id":{"type":"string","description":"The knowledge_base_reference_id of the knowledge base to perform the RAG if the question asked relates to the purpose of the knowledge_base_tool provided.","default":"kb-f9d817f5-46c2-49b2-b07f-f3db8df0887a","isRequired":true,"uniqueKey":"knowledge_base_id","typeLabel":"string"},"question_asked_by_user":{"type":"string","description":"The question asked by the user to perform the RAG.","default":"What is the purpose of this knowledge base?","isRequired":true,"uniqueKey":"question_asked_by_user","typeLabel":"string"}},"required":["knowledge_base_id","question_asked_by_user"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"knowledge_base_id":"kb-f9d817f5-46c2-49b2-b07f-f3db8df0887a","question_asked_by_user":"What is the purpose of this knowledge base?"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8fc5df55-d5ac-4b87-886f-04dc15a9a9f9":{"description":"Relevant chunks retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"finalRelevantChunk":{"description":"Final relevant chunk based on the user query.","example":["Hello Pawa AI, I am the final relevant chunk you need"],"type":"array","items":{"type":"string","uniqueKey":"finalRelevantChunk.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"finalRelevantChunk","typeLabel":"string[]"},"filteredResults":{"description":"Filtered results based on the relevance of the chunks to the user query.","example":[{"id":63,"knowledgeBaseId":7,"documentName":"131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf","chunk":"and for the whole period of staying in the Schengen area. In order to have a flexible travel schedule it is suggested to issue the Insurance for a few days longer than the planned travel time...","distance":0.7506968916261936},{"id":76,"knowledgeBaseId":7,"documentName":"131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf","chunk":"plan agreed with the clinic. Medical health documentation issued by the applicant’s country of residence...","distance":0.7515738980069386}],"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":63,"isRequired":true,"uniqueKey":"filteredResults.items.[INDEX].id","typeLabel":"number"},"knowledgeBaseId":{"type":"number","example":7,"isRequired":true,"uniqueKey":"filteredResults.items.[INDEX].knowledgeBaseId","typeLabel":"number"},"documentName":{"type":"string","example":"131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf","isRequired":true,"uniqueKey":"filteredResults.items.[INDEX].documentName","typeLabel":"string"},"chunk":{"type":"string","example":"and for the whole period of staying in the Schengen area...","isRequired":true,"uniqueKey":"filteredResults.items.[INDEX].chunk","typeLabel":"string"},"distance":{"type":"number","example":0.7506968916261936,"isRequired":true,"uniqueKey":"filteredResults.items.[INDEX].distance","typeLabel":"number"}},"required":["id","knowledgeBaseId","documentName","chunk","distance"],"uniqueKey":"filteredResults.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"filteredResults","typeLabel":"object[]"}},"required":["finalRelevantChunk","filteredResults"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"finalRelevantChunk":["Hello Pawa AI, I am the final relevant chunk you need"],"filteredResults":[{"id":63,"knowledgeBaseId":7,"documentName":"131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf","chunk":"and for the whole period of staying in the Schengen area. In order to have a flexible travel schedule it is suggested to issue the Insurance for a few days longer than the planned travel time...","distance":0.7506968916261936},{"id":76,"knowledgeBaseId":7,"documentName":"131.3-Visa-Requirements-Schengen-2021-05 (1) (1).pdf","chunk":"plan agreed with the clinic. Medical health documentation issued by the applicant’s country of residence...","distance":0.7515738980069386}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4061cc56-6ce7-4409-b49f-9ef6523c3cc3":{"description":"Bad Request","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"badRequest":{"title":"badRequest","value":{"success":false,"message":"Invalid input provided"}}},"exampleType":"examples"}},"exampleType":"examples"},"e3aa3431-0371-43de-b8fb-12ab54e1885e":{"description":"Unauthorized","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unauthorized":{"title":"unauthorized","value":{"success":false,"message":"Unauthorized access"}}},"exampleType":"examples"}},"exampleType":"examples"},"58c5602a-8478-42b7-8427-5ce8bd1badbc":{"description":"Forbidden","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"forbidden":{"title":"forbidden","value":{"success":false,"message":"You do not have permission to access this resource"}}},"exampleType":"examples"}},"exampleType":"examples"},"d59b5d30-6933-471e-bf55-963daa7028f7":{"description":"Not Found","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"notFound":{"title":"notFound","value":{"success":false,"message":"Resource does not exist"}}},"exampleType":"examples"}},"exampleType":"examples"},"39933bbf-dd34-4cc5-82a5-b6d84cf02799":{"description":"Too Many Requests","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"tooManyRequests":{"title":"tooManyRequests","value":{"success":false,"message":"Rate limit exceeded. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"98334d9d-099d-4a88-86aa-f0ab20763ee4":{"description":"Unexpected error","content":{"application/json":{"schema":{"required":["success","message"],"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"serverError":{"title":"serverError","value":{"success":false,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"5698ca4f-e7c7-48a5-b604-bfc0a680bf8f":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"26023518-7cd4-4c5f-8208-7ffe0de21022":{"url":"https://api.pawa-ai.com/v1","description":"Production Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sartifycoltd","siteName":"Pawa AI Docs","title":"Semantic Retrieval - Pawa AI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-25T11:15:58.656Z","originalFileLocation":"api-reference/endpoint/storage/knowledge-base/semantic-retrival.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pawa AI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Semantic Retrieval - Pawa AI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pawa AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sartifycoltd.mintlify.app/_mintlify/api/og/v2?division=Storage\u0026amp;title=Semantic+Retrieval\u0026amp;description=This+endpoint+used+to+retrieve+the+relevant+chunks+of+the+knowledge+base+based+on+the+user+question+in+the+Pawa+AI+Platform.\u0026amp;theme=28703d20165e3e96c0905c3a\u0026amp;signature=9bf72ad938a9c45f224339bbf737be63353f2fc5495c297b96ac1a32ffb1b38f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Semantic Retrieval - Pawa AI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sartifycoltd.mintlify.app/_mintlify/api/og/v2?division=Storage\u0026amp;title=Semantic+Retrieval\u0026amp;description=This+endpoint+used+to+retrieve+the+relevant+chunks+of+the+knowledge+base+based+on+the+user+question+in+the+Pawa+AI+Platform.\u0026amp;theme=28703d20165e3e96c0905c3a\u0026amp;signature=9bf72ad938a9c45f224339bbf737be63353f2fc5495c297b96ac1a32ffb1b38f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sartifycoltd/tZ9ouTRT8ZY057fP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pawa AI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFA200\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/storage/knowledge-base/semantic-retrival.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pawa-ai.com/#organization\",\"name\":\"Pawa AI Docs\",\"url\":\"https://docs.pawa-ai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sartifycoltd/ZmUMDiuhTZ-pD390/logo/pawa-logo-2.svg?fit=max\u0026auto=format\u0026n=ZmUMDiuhTZ-pD390\u0026q=85\u0026s=26ea97929a46ccbe6657a656b6447136\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pawa-ai.com#website\",\"name\":\"Pawa AI Docs\",\"url\":\"https://docs.pawa-ai.com\",\"publisher\":{\"@id\":\"https://docs.pawa-ai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival#webpage\",\"url\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival\",\"name\":\"Semantic Retrieval\",\"description\":\"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\",\"dateModified\":\"2025-09-25T11:15:58.656Z\",\"isPartOf\":{\"@id\":\"https://docs.pawa-ai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Storage\",\"item\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Semantic Retrieval\",\"item\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival#apireference\",\"headline\":\"Semantic Retrieval\",\"name\":\"Semantic Retrieval\",\"description\":\"This endpoint used to retrieve the relevant chunks of the knowledge base based on the user question in the Pawa AI Platform.\",\"url\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawa-ai.com/api-reference/endpoint/storage/knowledge-base/semantic-retrival#webpage\"},\"dateModified\":\"2025-09-25T11:15:58.656Z\",\"publisher\":{\"@id\":\"https://docs.pawa-ai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pawa-ai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pawa AI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pawa AI Docs","nav":{"global":{"anchors":[{"anchor":"SandBox","icon":"play","href":"https://builder.pawa-ai.com/dashboard?page=sandbox"},{"anchor":"Get Your API Key","icon":"key","href":"https://builder.pawa-ai.com/dashboard?page=keys"},{"anchor":"Examples","icon":"github","href":"https://github.com/Sartify/pawa-ai-blueprints-chatbots"},{"anchor":"Blogs","icon":"book","href":"https://pawa-ai.com/blogs"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Limits","href":"/api-reference/limits"}]},{"group":"Models","icon":"box","pages":[{"title":"Introduction","href":"/api-reference/endpoint/models/introduction"},{"title":"Get All Models","openapi":"GET /models","href":"/api-reference/endpoint/models/list"},{"title":"Get A Single Model","openapi":"GET /models/{id}","href":"/api-reference/endpoint/models/single"}]},{"group":"Chat","icon":"message","pages":[{"title":"Introduction","href":"/api-reference/endpoint/chat/introduction"},{"title":"Send Request","openapi":"POST /chat/request","href":"/api-reference/endpoint/chat/request"}]},{"group":"Voice","icon":"microphone","pages":[{"title":"Introduction","href":"/api-reference/endpoint/voice/introduction"},{"title":"Convert Text to speech","openapi":"POST /voice/text-to-speech","href":"/api-reference/endpoint/voice/text-to-speech"},{"title":"Convert Speech to text","openapi":"POST /voice/speech-to-text","href":"/api-reference/endpoint/voice/speech-to-text"}]},{"group":"Agents","icon":"head-side-gear","pages":[{"title":"Introduction","href":"/api-reference/endpoint/agents/introduction"},{"title":"Create Agents","openapi":"POST /agents/create","href":"/api-reference/endpoint/agents/create"},{"title":"Agents Conversation","openapi":"POST /agents/chat/request","href":"/api-reference/endpoint/agents/conversation"},{"title":"Agents Handoff","openapi":"POST /agents/chat/request","href":"/api-reference/endpoint/agents/handoff"},{"title":"Edit Agent","openapi":"PUT /agents/update/{id}","href":"/api-reference/endpoint/agents/update"},{"title":"Delete Agent","openapi":"DELETE /agents/delete/{id}","href":"/api-reference/endpoint/agents/delete"},{"title":"Get All Agents","openapi":"GET /agents/view","href":"/api-reference/endpoint/agents/view"},{"title":"Get Single Agent","openapi":"GET /agents/view/{id}","href":"/api-reference/endpoint/agents/view-single"}]},{"group":"Vectors","icon":"database","pages":[{"title":"Introduction","href":"/api-reference/endpoint/vectors/introduction"},{"title":"Create Embeddings","openapi":"POST /vectors/embedding","href":"/api-reference/endpoint/vectors/embeddings"}]},{"group":"Documents","icon":"file","pages":[{"title":"Introduction","href":"/api-reference/endpoint/documents/introduction"},{"title":"Parse Documents","openapi":"POST /documents/parse","href":"/api-reference/endpoint/documents/parse"}]},{"group":"Storage","icon":"server","pages":[{"title":"Introduction","href":"/api-reference/endpoint/storage/introduction"},{"title":"Create Knowledge Base","openapi":"POST /store/knowledge-base","href":"/api-reference/endpoint/storage/knowledge-base/create"},{"title":"Get All Knowledge Bases","openapi":"GET /store/knowledge-base","description":"This endpoint used to get all the knowledge bases registered in the Pawa AI Platform with pagination, search, and filtering support.","href":"/api-reference/endpoint/storage/knowledge-base/get-all"},{"title":"Semantic Retrieval","openapi":"POST /store/knowledge-base/semantic-retrieval","href":"/api-reference/endpoint/storage/knowledge-base/semantic-retrival"},{"title":"Get a Knowledge Base","openapi":"GET /store/knowledge-base/{id}","description":"This endpoint used to get the knowledge base by id in the Pawa AI Platform.","href":"/api-reference/endpoint/storage/knowledge-base/get-single"},{"title":"Delete a Knowledge Base","openapi":"DELETE /store/knowledge-base/{id}","href":"/api-reference/endpoint/storage/knowledge-base/delete"},{"title":"Edit a Knowledge Base","openapi":"PUT /store/knowledge-base/{id}","href":"/api-reference/endpoint/storage/knowledge-base/edit"},{"title":"Get Files of KB","openapi":"GET /store/files/knowledge-base/{id}","href":"/api-reference/endpoint/storage/knowledge-base/get-files"}]},{"group":"Transcribe","icon":"closed-captioning","pages":[{"title":"Introduction","href":"/api-reference/endpoint/transcribe/introduction"},{"title":"Create Workspace","openapi":"POST /transcribe/workspace","href":"/api-reference/endpoint/transcribe/create-workspace"},{"title":"Get All Workspaces","openapi":"GET /transcribe/workspace","href":"/api-reference/endpoint/transcribe/get-workspaces"},{"title":"Get A Single Workspace","openapi":"GET /transcribe/workspace/{id}","href":"/api-reference/endpoint/transcribe/get-workspace"},{"title":"Update Workspace","openapi":"PUT /transcribe/workspace/{id}","href":"/api-reference/endpoint/transcribe/update-workspace"},{"title":"Delete Workspace","openapi":"DELETE /transcribe/workspace/{id}","href":"/api-reference/endpoint/transcribe/delete-workspace"},{"title":"Upload Transcriptions","openapi":"POST /transcribe/workspace/{id}/transcriptions","href":"/api-reference/endpoint/transcribe/upload-transcriptions"},{"title":"Get Workspace Transcriptions","openapi":"GET /transcribe/workspace/{id}/transcriptions","href":"/api-reference/endpoint/transcribe/get-transcriptions"},{"title":"Update Transcription","openapi":"PATCH /transcribe/workspace/{id}/transcriptions/{transcriptionId}","href":"/api-reference/endpoint/transcribe/update-transcription"},{"title":"Delete Transcription","openapi":"DELETE /transcribe/workspace/{id}/transcriptions/{transcriptionId}","href":"/api-reference/endpoint/transcribe/delete-transcription"}]}]},{"tab":"Python SDK","pages":[{"title":"Python SDK","href":"/python-sdk/introduction"}]}]},"title":"Semantic Retrieval - Pawa AI Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}