Perform semantic search within a vector store and filter down to a specific file.
Provide the file_id to search within the file, don’t confuse it with parse_result_id, because the two are connected.
This endpoint performs vector-based semantic search to find the most relevant content
based on the provided query. The search uses embeddings to find semantically similar content.
Search Parameters:
query: The search query text
top_k: Number of results to return (ranked by relevance)
filters: Optional filters to narrow search scope (e.g., by file_id)
Authentication:
Credentials can be provided either through project-level credentials or request-level credentials
For SGP Knowledge Base, SGP credentials are required
Returns:
Ranked list of relevant content chunks
Each chunk includes content, source blocks, relevance score, and parse result ID
Results are ordered by relevance score (highest first)
Example Request:
{ "query": "What are the main features of the product?", "top_k": 5, "filters": { "file_id": "file_123" }, "credentials": { "sgp": { "api_key": "your-api-key", "base_url": "https://api.example.com" } }}
Example Response:
{ "chunks": [ { "content": "The product includes advanced analytics, real-time monitoring, and automated reporting features.", "blocks": [ { "id": "block_123", "content": "The product includes advanced analytics...", "type": "text" } ], "score": 0.95, "parse_result_id": "parse_123" } ]}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scale AI","colors":{"primary":"#3f2e7b","light":"#ca62ff","dark":"#3f2e7b"},"logo":{"light":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b","dark":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/dark.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=02733f39d684d796ec742853eabf0de5"},"favicon":"https://mintcdn.com/scalegp/1vQnbXFkjbQbcgd1/favicon.png?fit=max\u0026auto=format\u0026n=1vQnbXFkjbQbcgd1\u0026q=85\u0026s=f52c84ba46a7cca58551673616dabe9c","background":{"decoration":"windows"},"navbar":{"links":[],"primary":{"type":"button","label":"Platform","href":"https://app.sgp.scale.com/"}},"footer":{"socials":{"x":"https://x.com/scale_ai","facebook":"https://www.facebook.com/scaleapi","linkedin":"https://www.linkedin.com/company/scaleai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scalegp","hasAudioNarration":false,"actualSubdomain":"scalegp","customDomains":["docs.gp.scale.com"],"gitSource":{"type":"github","owner":"scaleapi","repo":"sgp-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abeb90f3a8b8379c1eaf648","collectionId":"437f531c-55bf-41b5-8f5d-4e63781df61e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abeb90f3a8b8379c1eaf648"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6abeb90f3a8b8379c1eaf648","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"AgentOps API","count":141},{"language":"default","tag":"Guides","count":131},{"language":"default","tag":"Agentex API","count":94},{"language":"default","tag":"Evaluations","count":72},{"language":"default","tag":"Dex API","count":48},{"language":"default","tag":"Agents","count":41},{"language":"default","tag":"Evaluation Datasets","count":34},{"language":"default","tag":"Models","count":32},{"language":"default","tag":"Knowledge Bases","count":31}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Aeonik';src:url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2);font-weight:400;font-style:normal;font-display:swap}h1,h2,h3{font-family:'aeonik';letter-spacing:normal!important}"}],"page":{"pagePath":"reference/dex/vector-stores/search-in-vector-stores-file","slug":"/reference/dex/vector-stores/search-in-vector-stores-file","pageMetadata":{"title":"Search in vector store's file","description":"Perform semantic search within a vector store and filter down to a specific file.\n Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected.\n\n This endpoint performs vector-based semantic search to find the most relevant content\n based on the provided query. The search uses embeddings to find semantically similar content.\n\n **Search Parameters:**\n - `query`: The search query text\n - `top_k`: Number of results to return (ranked by relevance)\n - `filters`: Optional filters to narrow search scope (e.g., by file_id)\n\n **Authentication:**\n - Credentials can be provided either through project-level credentials or request-level credentials\n - For SGP Knowledge Base, SGP credentials are required\n\n **Returns:**\n - Ranked list of relevant content chunks\n - Each chunk includes content, source blocks, relevance score, and parse result ID\n - Results are ordered by relevance score (highest first)\n\n **Example Request:**\n ```json\n {\n \"query\": \"What are the main features of the product?\",\n \"top_k\": 5,\n \"filters\": {\n \"file_id\": \"file_123\"\n },\n \"credentials\": {\n \"sgp\": {\n \"api_key\": \"your-api-key\",\n \"base_url\": \"https://api.example.com\"\n }\n }\n }\n ```\n\n **Example Response:**\n ```json\n {\n \"chunks\": [\n {\n \"content\": \"The product includes advanced analytics, real-time monitoring, and automated reporting features.\",\n \"blocks\": [\n {\n \"id\": \"block_123\",\n \"content\": \"The product includes advanced analytics...\",\n \"type\": \"text\"\n }\n ],\n \"score\": 0.95,\n \"parse_result_id\": \"parse_123\"\n }\n ]\n }\n ```","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores/{vector_store_id}/files/{file_id}/search","href":"/reference/dex/vector-stores/search-in-vector-stores-file","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Perform semantic search within a vector store and filter down to a specific file.\\nProvide the file_id to search within the file, don’t confuse it with parse_result_id, because the two are connected.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint performs vector-based semantic search to find the most relevant content\\nbased on the provided query. The search uses embeddings to find semantically similar content.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Search Parameters:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"query\"\n }), \": The search query text\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"top_k\"\n }), \": Number of results to return (ranked by relevance)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"filters\"\n }), \": Optional filters to narrow search scope (e.g., by file_id)\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Authentication:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Credentials can be provided either through project-level credentials or request-level credentials\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"For SGP Knowledge Base, SGP credentials are required\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Returns:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Ranked list of relevant content chunks\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Each chunk includes content, source blocks, relevance score, and parse result ID\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Results are ordered by relevance score (highest first)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example Request:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"13\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"13\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"query\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"What are the main features of the product?\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"top_k\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"5\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"filters\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"file_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"file_123\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" },\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"credentials\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"sgp\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"api_key\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"your-api-key\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"base_url\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"https://api.example.com\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example Response:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"16\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"16\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"chunks\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"content\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"The product includes advanced analytics, real-time monitoring, and automated reporting features.\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"blocks\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"block_123\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"content\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"The product includes advanced analytics...\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"type\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"text\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ],\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"score\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"0.95\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"parse_result_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"parse_123\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ]\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"Search in vector store's file","description":"Perform semantic search within a vector store and filter down to a specific file.\n Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected.\n\n This endpoint performs vector-based semantic search to find the most relevant content\n based on the provided query. The search uses embeddings to find semantically similar content.\n\n **Search Parameters:**\n - `query`: The search query text\n - `top_k`: Number of results to return (ranked by relevance)\n - `filters`: Optional filters to narrow search scope (e.g., by file_id)\n\n **Authentication:**\n - Credentials can be provided either through project-level credentials or request-level credentials\n - For SGP Knowledge Base, SGP credentials are required\n\n **Returns:**\n - Ranked list of relevant content chunks\n - Each chunk includes content, source blocks, relevance score, and parse result ID\n - Results are ordered by relevance score (highest first)\n\n **Example Request:**\n ```json\n {\n \"query\": \"What are the main features of the product?\",\n \"top_k\": 5,\n \"filters\": {\n \"file_id\": \"file_123\"\n },\n \"credentials\": {\n \"sgp\": {\n \"api_key\": \"your-api-key\",\n \"base_url\": \"https://api.example.com\"\n }\n }\n }\n ```\n\n **Example Response:**\n ```json\n {\n \"chunks\": [\n {\n \"content\": \"The product includes advanced analytics, real-time monitoring, and automated reporting features.\",\n \"blocks\": [\n {\n \"id\": \"block_123\",\n \"content\": \"The product includes advanced analytics...\",\n \"type\": \"text\"\n }\n ],\n \"score\": 0.95,\n \"parse_result_id\": \"parse_123\"\n }\n ]\n }\n ```","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores/{vector_store_id}/files/{file_id}/search","href":"/reference/dex/vector-stores/search-in-vector-stores-file","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Vector Stores"],"summary":"Search in vector store's file","description":"Perform semantic search within a vector store and filter down to a specific file.\n Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected.\n\n This endpoint performs vector-based semantic search to find the most relevant content\n based on the provided query. The search uses embeddings to find semantically similar content.\n\n **Search Parameters:**\n - `query`: The search query text\n - `top_k`: Number of results to return (ranked by relevance)\n - `filters`: Optional filters to narrow search scope (e.g., by file_id)\n\n **Authentication:**\n - Credentials can be provided either through project-level credentials or request-level credentials\n - For SGP Knowledge Base, SGP credentials are required\n\n **Returns:**\n - Ranked list of relevant content chunks\n - Each chunk includes content, source blocks, relevance score, and parse result ID\n - Results are ordered by relevance score (highest first)\n\n **Example Request:**\n ```json\n {\n \"query\": \"What are the main features of the product?\",\n \"top_k\": 5,\n \"filters\": {\n \"file_id\": \"file_123\"\n },\n \"credentials\": {\n \"sgp\": {\n \"api_key\": \"your-api-key\",\n \"base_url\": \"https://api.example.com\"\n }\n }\n }\n ```\n\n **Example Response:**\n ```json\n {\n \"chunks\": [\n {\n \"content\": \"The product includes advanced analytics, real-time monitoring, and automated reporting features.\",\n \"blocks\": [\n {\n \"id\": \"block_123\",\n \"content\": \"The product includes advanced analytics...\",\n \"type\": \"text\"\n }\n ],\n \"score\": 0.95,\n \"parse_result_id\": \"parse_123\"\n }\n ]\n }\n ```","operationId":"search_in_vector_store_file_v1_projects__project_id__vector_stores__vector_store_id__files__file_id__search_post","parameters":["4cb6f21f-6a3b-4f0c-9094-7ae6ac2e3110","7f2f90fb-ef18-4f3f-ab51-22358fd65335","904345a2-9c1b-49d6-b0f8-c3ee3c74c690"],"requestBody":"f4cfba15-501a-4341-b621-e41cb7ebab7f","responses":{"200":"5815d57a-40f5-4339-8e7f-7fd30c860018","400":"26600c62-41c5-4206-be28-32d9e1f6b80d","404":"f3bc5bb3-405a-4fc9-87da-23e5316ec87f","422":"b81a986f-dce9-42f6-b4c5-fa926d110385","500":"386499fc-448e-40cb-ae97-769d87a98665"},"method":"post","type":"path","servers":[],"security":["3d5b6088-a4a5-4a82-8450-48a5ac5593af"],"path":"/v1/projects/{project_id}/vector-stores/{vector_store_id}/files/{file_id}/search","baseUrlOptions":[],"title":"Search in vector store's file","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4cb6f21f-6a3b-4f0c-9094-7ae6ac2e3110":{"name":"project_id","in":"path","required":true,"schema":{"type":"string","title":"Project Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"7f2f90fb-ef18-4f3f-ab51-22358fd65335":{"name":"vector_store_id","in":"path","required":true,"schema":{"type":"string","title":"Vector Store Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"904345a2-9c1b-49d6-b0f8-c3ee3c74c690":{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query","description":"Query to search for","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"top_k":{"oneOf":[{"type":"integer","title":"Top K","description":"Number of results to return","uniqueKey":"top_k.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Top K","description":"Number of results to return","uniqueKey":"top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_k","typeLabel":"integer | null"},"filters":{"oneOf":[{"type":"object","title":"Filters","description":"Filters to apply to the search. For example, {file_id: 123}","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"filters.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"filters.oneOf.0.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"filters.oneOf.0.additionalProperties","typeLabel":"string | object"},"uniqueKey":"filters.oneOf.0","typeLabel":"Filters · object"},{"type":"null","title":"Filters","description":"Filters to apply to the search. For example, {file_id: 123}","uniqueKey":"filters.oneOf.1","typeLabel":"null"}],"uniqueKey":"filters","typeLabel":"Filters · object | null"},"rerank_config":{"oneOf":[{"type":"object","title":"RerankConfig","description":"Reranking configuration. This is only applicable for SGP Vector Stores.","properties":{"model":{"oneOf":[{"type":"string","title":"Model","description":"Reranking model to use (uses system default if not specified)","uniqueKey":"rerank_config.oneOf.0.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"Reranking model to use (uses system default if not specified)","uniqueKey":"rerank_config.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_config.oneOf.0.model","typeLabel":"string | null"},"top_n":{"oneOf":[{"type":"integer","title":"Top N","description":"Number of results to keep after reranking (defaults to top_k)","minimum":1,"uniqueKey":"rerank_config.oneOf.0.top_n.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Top N","description":"Number of results to keep after reranking (defaults to top_k)","uniqueKey":"rerank_config.oneOf.0.top_n.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_config.oneOf.0.top_n","typeLabel":"integer | null"},"instruction":{"oneOf":[{"type":"string","title":"Instruction","description":"Custom instruction for the reranking model (e.g., 'Given a medical question, retrieve relevant clinical passages'). Only applies to instruction-following rerankers like Qwen3.","uniqueKey":"rerank_config.oneOf.0.instruction.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instruction","description":"Custom instruction for the reranking model (e.g., 'Given a medical question, retrieve relevant clinical passages'). Only applies to instruction-following rerankers like Qwen3.","uniqueKey":"rerank_config.oneOf.0.instruction.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_config.oneOf.0.instruction","typeLabel":"string | null"}},"uniqueKey":"rerank_config.oneOf.0","typeLabel":"RerankConfig · object"},{"type":"null","description":"Reranking configuration. This is only applicable for SGP Vector Stores.","uniqueKey":"rerank_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_config","typeLabel":"RerankConfig · object | null"},"query_type":{"oneOf":[{"type":"string","title":"Query Type","description":"Type of query to perform.","enum":["semantic","lexical","hybrid"],"uniqueKey":"query_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Query Type","description":"Type of query to perform.","uniqueKey":"query_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"query_type","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":true,"type":"object","required":["query"],"title":"VectorStoreSearchParams","description":"Search parameters for vector store engines. Extend this model to add new parameters without changing the engine interface.","uniqueKey":"","typeLabel":"VectorStoreSearchParams · object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","top_k":123,"filters":{},"rerank_config":{"model":"\u003cstring>","top_n":2,"instruction":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5815d57a-40f5-4339-8e7f-7fd30c860018":{"description":"Search completed successfully","content":{"application/json":{"schema":{"properties":{"chunks":{"items":{"properties":{"content":{"type":"string","title":"Content","description":"Content of the chunk","isRequired":true,"uniqueKey":"chunks.items.[INDEX].content","typeLabel":"string"},"blocks":{"items":{"properties":{"type":{"type":"string","title":"Type","description":"Block type (text, table, figure, header, etc.)","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].type","typeLabel":"string"},"content":{"type":"string","title":"Content","description":"The actual content (text, HTML, etc.)","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].content","typeLabel":"string"},"bbox":{"properties":{"left":{"type":"number","title":"Left","description":"Left coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].bbox.left","typeLabel":"number"},"top":{"type":"number","title":"Top","description":"Top coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].bbox.top","typeLabel":"number"},"width":{"type":"number","title":"Width","description":"Width","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].bbox.width","typeLabel":"number"},"height":{"type":"number","title":"Height","description":"Height","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].bbox.height","typeLabel":"number"}},"type":"object","required":["left","top","width","height"],"title":"BoundingBox","description":"Bounding box locations for this block","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].bbox","typeLabel":"BoundingBox · object"},"confidence":{"type":"number","title":"Confidence","description":"Confidence score (0-1)","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].confidence","typeLabel":"number"},"page_number":{"type":"integer","title":"Page Number","description":"Page number on the document","default":0,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].page_number","typeLabel":"integer"},"error":{"oneOf":[{"type":"string","title":"Error","description":"Per-region OCR error string when the model could not extract content (e.g. 'IRIS-ERROR: blank image', 'HTTP-ERROR: soft-timeout 60s exceeded'). None when the region was processed successfully (including the legitimate case of an empty region with no text to extract).","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error","description":"Per-region OCR error string when the model could not extract content (e.g. 'IRIS-ERROR: blank image', 'HTTP-ERROR: soft-timeout 60s exceeded'). None when the region was processed successfully (including the legitimate case of an empty region with no text to extract).","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].error","typeLabel":"string | null"},"row_bboxes":{"oneOf":[{"type":"array","items":{"properties":{"left":{"type":"number","title":"Left","description":"Left coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0.items.[INDEX].left","typeLabel":"number"},"top":{"type":"number","title":"Top","description":"Top coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0.items.[INDEX].top","typeLabel":"number"},"width":{"type":"number","title":"Width","description":"Width","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0.items.[INDEX].width","typeLabel":"number"},"height":{"type":"number","title":"Height","description":"Height","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0.items.[INDEX].height","typeLabel":"number"}},"type":"object","required":["left","top","width","height"],"title":"BoundingBox","description":"Bounding box information for location in document.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0.items.[INDEX]","typeLabel":"BoundingBox · object"},"title":"Row Bboxes","description":"Per-row bounding boxes for a table block, normalized to the full page like `bbox`. Populated by table substructure recognition; None otherwise.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.0","typeLabel":"BoundingBox · object[]"},{"type":"null","title":"Row Bboxes","description":"Per-row bounding boxes for a table block, normalized to the full page like `bbox`. Populated by table substructure recognition; None otherwise.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].row_bboxes","typeLabel":"BoundingBox · object[] | null"},"col_bboxes":{"oneOf":[{"type":"array","items":{"properties":{"left":{"type":"number","title":"Left","description":"Left coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0.items.[INDEX].left","typeLabel":"number"},"top":{"type":"number","title":"Top","description":"Top coordinate","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0.items.[INDEX].top","typeLabel":"number"},"width":{"type":"number","title":"Width","description":"Width","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0.items.[INDEX].width","typeLabel":"number"},"height":{"type":"number","title":"Height","description":"Height","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0.items.[INDEX].height","typeLabel":"number"}},"type":"object","required":["left","top","width","height"],"title":"BoundingBox","description":"Bounding box information for location in document.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0.items.[INDEX]","typeLabel":"BoundingBox · object"},"title":"Col Bboxes","description":"Per-column bounding boxes for a table block, normalized to the full page like `bbox`. Populated by table substructure recognition; None otherwise.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.0","typeLabel":"BoundingBox · object[]"},{"type":"null","title":"Col Bboxes","description":"Per-column bounding boxes for a table block, normalized to the full page like `bbox`. Populated by table substructure recognition; None otherwise.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX].col_bboxes","typeLabel":"BoundingBox · object[] | null"}},"type":"object","required":["type","content","bbox","confidence"],"title":"ParseBlock","description":"A block of content from parsing with location information.","uniqueKey":"chunks.items.[INDEX].blocks.items.[INDEX]","typeLabel":"ParseBlock · object"},"type":"array","title":"Blocks","description":"Blocks of the chunk","isRequired":true,"uniqueKey":"chunks.items.[INDEX].blocks","typeLabel":"ParseBlock · object[]"},"score":{"type":"number","title":"Score","description":"Score of the chunk","isRequired":true,"uniqueKey":"chunks.items.[INDEX].score","typeLabel":"number"},"file_id":{"oneOf":[{"type":"string","title":"File Id","description":"ID of the file","isRequired":true,"uniqueKey":"chunks.items.[INDEX].file_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"File Id","description":"ID of the file","isRequired":true,"uniqueKey":"chunks.items.[INDEX].file_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"chunks.items.[INDEX].file_id","typeLabel":"string | null"},"parse_result_id":{"oneOf":[{"type":"string","title":"Parse Result Id","description":"ID of the parse result","isRequired":true,"uniqueKey":"chunks.items.[INDEX].parse_result_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parse Result Id","description":"ID of the parse result","isRequired":true,"uniqueKey":"chunks.items.[INDEX].parse_result_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"chunks.items.[INDEX].parse_result_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Additional metadata from the chunk","additionalProperties":true,"uniqueKey":"chunks.items.[INDEX].metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Additional metadata from the chunk","uniqueKey":"chunks.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"chunks.items.[INDEX].metadata","typeLabel":"Metadata · object | null"}},"type":"object","required":["content","blocks","score","file_id","parse_result_id"],"title":"VectorStoreChunk","uniqueKey":"chunks.items.[INDEX]","typeLabel":"VectorStoreChunk · object"},"type":"array","title":"Chunks","description":"Chunks of the search result","isRequired":true,"uniqueKey":"chunks","typeLabel":"VectorStoreChunk · object[]"}},"type":"object","required":["chunks"],"title":"VectorStoreSearchResult","uniqueKey":"","typeLabel":"VectorStoreSearchResult · object"},"examples":{"Example":{"title":"Example","value":{"chunks":[{"content":"\u003cstring>","blocks":[{"type":"\u003cstring>","content":"\u003cstring>","bbox":{"left":123,"top":123,"width":123,"height":123},"confidence":123,"page_number":0,"error":"\u003cstring>","row_bboxes":[{"left":123,"top":123,"width":123,"height":123}],"col_bboxes":[{"left":123,"top":123,"width":123,"height":123}]}],"score":123,"file_id":"\u003cstring>","parse_result_id":"\u003cstring>","metadata":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"26600c62-41c5-4206-be28-32d9e1f6b80d":{"description":"Bad request - Invalid credentials or missing required fields","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f3bc5bb3-405a-4fc9-87da-23e5316ec87f":{"description":"Project or vector store not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b81a986f-dce9-42f6-b4c5-fa926d110385":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"386499fc-448e-40cb-ae97-769d87a98665":{"description":"Internal server error - Search operation failed","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"3d5b6088-a4a5-4a82-8450-48a5ac5593af":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication","scopes":[]},"AccountId":{"type":"apiKey","in":"header","name":"x-selected-account-id","description":"Selected Account ID","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"},{"scheme":{"type":"apiKey","in":"header","name":"x-selected-account-id","description":"Selected Account ID","scopes":[]},"schema":{"title":"x-selected-account-id","type":"string","description":"Selected Account ID","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccountId","name":"x-selected-account-id"}],"title":"ApiKey \u0026 AccountId"}]},"originalFileLocation":"https://dex.sgp.scale.com/openapi.json"},"subdomain":"scalegp","siteName":"Scale AI","title":"Search in vector store's file - Scale AI","navMaps":{"firstHrefInVersion":{"V5":{"href":"/reference/dex/vector-stores/search-in-vector-stores-file","matchLevel":0},"V4 (legacy)":{"href":"/home","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T19:56:23.370Z","originalFileLocation":"reference/dex/vector-stores/search-in-vector-stores-file.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=\"Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don\u0026#x27;t confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. Search Parameters: - query: The search query text - top_k: Number of results to return (ranked by relevance) - filters: Optional filters to narrow search scope (e.g., by file_id) Authentication: - Credentials can be provided either through project-level credentials or request-level credentials - For SGP Knowledge Base, SGP credentials are required Returns: - Ranked list of relevant content chunks - Each chunk includes content, source blocks, relevance score, and parse result ID - Results are ordered by relevance score (highest first) Example Request: json { \u0026quot;query\u0026quot;: \u0026quot;What are the main features of the product?\u0026quot;, \u0026quot;top_k\u0026quot;: 5, \u0026quot;filters\u0026quot;: { \u0026quot;file_id\u0026quot;: \u0026quot;file_123\u0026quot; }, \u0026quot;credentials\u0026quot;: { \u0026quot;sgp\u0026quot;: { \u0026quot;api_key\u0026quot;: \u0026quot;your-api-key\u0026quot;, \u0026quot;base_url\u0026quot;: \u0026quot;https://api.example.com\u0026quot; } } } Example Response: json { \u0026quot;chunks\u0026quot;: [ { \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics, real-time monitoring, and automated reporting features.\u0026quot;, \u0026quot;blocks\u0026quot;: [ { \u0026quot;id\u0026quot;: \u0026quot;block_123\u0026quot;, \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics...\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;text\u0026quot; } ], \u0026quot;score\u0026quot;: 0.95, \u0026quot;parse_result_id\u0026quot;: \u0026quot;parse_123\u0026quot; } ] }\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search in vector store\u0026#x27;s file - Scale AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don\u0026#x27;t confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. Search Parameters: - query: The search query text - top_k: Number of results to return (ranked by relevance) - filters: Optional filters to narrow search scope (e.g., by file_id) Authentication: - Credentials can be provided either through project-level credentials or request-level credentials - For SGP Knowledge Base, SGP credentials are required Returns: - Ranked list of relevant content chunks - Each chunk includes content, source blocks, relevance score, and parse result ID - Results are ordered by relevance score (highest first) Example Request: json { \u0026quot;query\u0026quot;: \u0026quot;What are the main features of the product?\u0026quot;, \u0026quot;top_k\u0026quot;: 5, \u0026quot;filters\u0026quot;: { \u0026quot;file_id\u0026quot;: \u0026quot;file_123\u0026quot; }, \u0026quot;credentials\u0026quot;: { \u0026quot;sgp\u0026quot;: { \u0026quot;api_key\u0026quot;: \u0026quot;your-api-key\u0026quot;, \u0026quot;base_url\u0026quot;: \u0026quot;https://api.example.com\u0026quot; } } } Example Response: json { \u0026quot;chunks\u0026quot;: [ { \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics, real-time monitoring, and automated reporting features.\u0026quot;, \u0026quot;blocks\u0026quot;: [ { \u0026quot;id\u0026quot;: \u0026quot;block_123\u0026quot;, \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics...\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;text\u0026quot; } ], \u0026quot;score\u0026quot;: 0.95, \u0026quot;parse_result_id\u0026quot;: \u0026quot;parse_123\u0026quot; } ] }\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scale AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scalegp.mintlify.app/_mintlify/api/og/v2?division=Vector+Stores\u0026amp;title=Search+in+vector+store%27s+file\u0026amp;description=Perform+semantic+search+within+a+vector+store+and+filter+down+to+a+specific+file.%0A++++Provide+the+file_id+to+search+within+the+file%2C+don%27t+confuse+it+with+parse\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=ef4b49a57e99ef7b2b64baad8683f98ca9243f27e4348b6fd6a5b1b6e1a85e98\">\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=\"Search in vector store\u0026#x27;s file - Scale AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don\u0026#x27;t confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. Search Parameters: - query: The search query text - top_k: Number of results to return (ranked by relevance) - filters: Optional filters to narrow search scope (e.g., by file_id) Authentication: - Credentials can be provided either through project-level credentials or request-level credentials - For SGP Knowledge Base, SGP credentials are required Returns: - Ranked list of relevant content chunks - Each chunk includes content, source blocks, relevance score, and parse result ID - Results are ordered by relevance score (highest first) Example Request: json { \u0026quot;query\u0026quot;: \u0026quot;What are the main features of the product?\u0026quot;, \u0026quot;top_k\u0026quot;: 5, \u0026quot;filters\u0026quot;: { \u0026quot;file_id\u0026quot;: \u0026quot;file_123\u0026quot; }, \u0026quot;credentials\u0026quot;: { \u0026quot;sgp\u0026quot;: { \u0026quot;api_key\u0026quot;: \u0026quot;your-api-key\u0026quot;, \u0026quot;base_url\u0026quot;: \u0026quot;https://api.example.com\u0026quot; } } } Example Response: json { \u0026quot;chunks\u0026quot;: [ { \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics, real-time monitoring, and automated reporting features.\u0026quot;, \u0026quot;blocks\u0026quot;: [ { \u0026quot;id\u0026quot;: \u0026quot;block_123\u0026quot;, \u0026quot;content\u0026quot;: \u0026quot;The product includes advanced analytics...\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;text\u0026quot; } ], \u0026quot;score\u0026quot;: 0.95, \u0026quot;parse_result_id\u0026quot;: \u0026quot;parse_123\u0026quot; } ] }\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scalegp.mintlify.app/_mintlify/api/og/v2?division=Vector+Stores\u0026amp;title=Search+in+vector+store%27s+file\u0026amp;description=Perform+semantic+search+within+a+vector+store+and+filter+down+to+a+specific+file.%0A++++Provide+the+file_id+to+search+within+the+file%2C+don%27t+confuse+it+with+parse\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=ef4b49a57e99ef7b2b64baad8683f98ca9243f27e4348b6fd6a5b1b6e1a85e98\">\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/scalegp/UksUEh3sxckFW0X-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3f2e7b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/dex/vector-stores/search-in-vector-stores-file.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gp.scale.com/#organization\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gp.scale.com#website\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file#webpage\",\"url\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file\",\"name\":\"Search in vector store's file\",\"description\":\"Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. Search Parameters: - query: The search query text - top_k: Number of results to return (ranked by relevance) - filters: Optional filters to narrow search scope (e.g., by file_id) Authentication: - Credentials can be provided either through project-level credentials or request-level credentials - For SGP Knowledge Base, SGP credentials are required Returns: - Ranked list of relevant content chunks - Each chunk includes content, source blocks, relevance score, and parse result ID - Results are ordered by relevance score (highest first) Example Request: json { \\\"query\\\": \\\"What are the main features of the product?\\\", \\\"top_k\\\": 5, \\\"filters\\\": { \\\"file_id\\\": \\\"file_123\\\" }, \\\"credentials\\\": { \\\"sgp\\\": { \\\"api_key\\\": \\\"your-api-key\\\", \\\"base_url\\\": \\\"https://api.example.com\\\" } } } Example Response: json { \\\"chunks\\\": [ { \\\"content\\\": \\\"The product includes advanced analytics, real-time monitoring, and automated reporting features.\\\", \\\"blocks\\\": [ { \\\"id\\\": \\\"block_123\\\", \\\"content\\\": \\\"The product includes advanced analytics...\\\", \\\"type\\\": \\\"text\\\" } ], \\\"score\\\": 0.95, \\\"parse_result_id\\\": \\\"parse_123\\\" } ] }\",\"dateModified\":\"2026-09-28T19:56:23.370Z\",\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Vector Stores\",\"item\":\"https://docs.gp.scale.com/reference/dex/vector-stores/list-vector-stores\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search in vector store's file\",\"item\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file#apireference\",\"headline\":\"Search in vector store's file\",\"name\":\"Search in vector store's file\",\"description\":\"Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. Search Parameters: - query: The search query text - top_k: Number of results to return (ranked by relevance) - filters: Optional filters to narrow search scope (e.g., by file_id) Authentication: - Credentials can be provided either through project-level credentials or request-level credentials - For SGP Knowledge Base, SGP credentials are required Returns: - Ranked list of relevant content chunks - Each chunk includes content, source blocks, relevance score, and parse result ID - Results are ordered by relevance score (highest first) Example Request: json { \\\"query\\\": \\\"What are the main features of the product?\\\", \\\"top_k\\\": 5, \\\"filters\\\": { \\\"file_id\\\": \\\"file_123\\\" }, \\\"credentials\\\": { \\\"sgp\\\": { \\\"api_key\\\": \\\"your-api-key\\\", \\\"base_url\\\": \\\"https://api.example.com\\\" } } } Example Response: json { \\\"chunks\\\": [ { \\\"content\\\": \\\"The product includes advanced analytics, real-time monitoring, and automated reporting features.\\\", \\\"blocks\\\": [ { \\\"id\\\": \\\"block_123\\\", \\\"content\\\": \\\"The product includes advanced analytics...\\\", \\\"type\\\": \\\"text\\\" } ], \\\"score\\\": 0.95, \\\"parse_result_id\\\": \\\"parse_123\\\" } ] }\",\"url\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file#webpage\"},\"dateModified\":\"2026-09-28T19:56:23.370Z\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"}}]}\u003c/script>","siteName":"Scale AI","nav":{"global":null,"versions":[{"version":"V5","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/v5/overview"}]},{"tab":"AgentOps API","pages":[{"title":"AgentOps API","href":"/reference/v5/inference/run-inference-with-free-form-payload"}]},{"tab":"AgentOps SDK","href":"https://scaleapi.github.io/sgp-sdk-docs/api/python/"},{"tab":"Agentex API","pages":[{"title":"Agentex API","href":"/reference/agentex/agents/get-agent-by-id"}]},{"tab":"Agentex SDK","href":"https://scaleapi.github.io/agentex-sdk-docs/api/python/"},{"tab":"Capabilities","pages":[{"title":"Capabilities","href":"/docs/capabilities/overview"}]},{"tab":"Dex API","groups":[{"group":"Projects","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects","href":"/reference/dex/projects/list-projects"},{"title":"Create Project","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects","href":"/reference/dex/projects/create-project"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}","href":"/reference/dex/projects/get-project"},{"title":"Update Project","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json put /v1/projects/{project_id}","href":"/reference/dex/projects/update-project"}]},{"group":"Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/files","href":"/reference/dex/files/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/files","href":"/reference/dex/files/upload-file"},{"title":"Get By Id","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/files/{file_id}","href":"/reference/dex/files/get-by-id"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/files/{file_id}","href":"/reference/dex/files/delete-file"},{"title":"Get File Download Url","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/files/{file_id}/download-url","href":"/reference/dex/files/get-file-download-url"},{"title":"Stream File Content","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/files/{file_id}/stream","href":"/reference/dex/files/stream-file-content"}]},{"group":"Parse","pages":[{"title":"Create Parse Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/parse","href":"/reference/dex/parse/create-parse-job"},{"title":"Create Batch Parse Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/parse/batch","href":"/reference/dex/parse/create-batch-parse-job"},{"title":"List Parse Results","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/parse/results","href":"/reference/dex/parse/list-parse-results"},{"title":"Get Parse Result","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/parse/{parse_result_id}/result","href":"/reference/dex/parse/get-parse-result"},{"title":"Upload Parse Result","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/parse/upload-result","href":"/reference/dex/parse/upload-parse-result"},{"title":"Create Chunk Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/parse/{parse_result_id}/rechunk","href":"/reference/dex/parse/create-chunk-job"}]},{"group":"Vector Stores","pages":[{"title":"List vector stores","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/vector-stores","href":"/reference/dex/vector-stores/list-vector-stores"},{"title":"Create a new vector store","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores","href":"/reference/dex/vector-stores/create-a-new-vector-store"},{"title":"Get vector store details","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/vector-stores/{vector_store_id}","href":"/reference/dex/vector-stores/get-vector-store-details"},{"title":"Delete a vector store","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/vector-stores/{vector_store_id}","href":"/reference/dex/vector-stores/delete-a-vector-store"},{"title":"List files in vector store","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/vector-stores/{vector_store_id}/files","href":"/reference/dex/vector-stores/list-files-in-vector-store"},{"title":"Add files to vector store","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores/{vector_store_id}/files","href":"/reference/dex/vector-stores/add-files-to-vector-store"},{"title":"Remove files from vector store","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/vector-stores/{vector_store_id}/files","href":"/reference/dex/vector-stores/remove-files-from-vector-store"},{"title":"Search in vector store","description":"Perform semantic search within a vector store.\n\n This endpoint performs vector-based semantic search to find the most relevant content\n based on the provided query. The search uses embeddings to find semantically similar content.\n\n **Search Parameters:**\n - `query`: The search query text\n - `top_k`: Number of results to return (ranked by relevance)\n - `filters`: Optional filters to narrow search scope (e.g., by file_id)\n\n **Authentication:**\n - Credentials can be provided either through project-level credentials or request-level credentials\n - For SGP Knowledge Base, SGP credentials are required\n\n **Returns:**\n - Ranked list of relevant content chunks\n - Each chunk includes content, source blocks, relevance score, and parse result ID\n - Results are ordered by relevance score (highest first)\n\n **Example Request:**\n ```json\n {\n \"query\": \"What are the main features of the product?\",\n \"top_k\": 5,\n \"filters\": {\n \"file_id\": \"file_123\"\n },\n \"credentials\": {\n \"sgp\": {\n \"api_key\": \"your-api-key\",\n \"base_url\": \"https://api.example.com\"\n }\n }\n }\n ```\n\n **Example Response:**\n ```json\n {\n \"chunks\": [\n {\n \"content\": \"The product includes advanced analytics, real-time monitoring, and automated reporting features.\",\n \"blocks\": [\n {\n \"id\": \"block_123\",\n \"content\": \"The product includes advanced analytics...\",\n \"type\": \"text\"\n }\n ],\n \"score\": 0.95,\n \"parse_result_id\": \"parse_123\"\n }\n ]\n }\n ```","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores/{vector_store_id}/search","href":"/reference/dex/vector-stores/search-in-vector-store"},{"title":"Search in vector store's file","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/vector-stores/{vector_store_id}/files/{file_id}/search","href":"/reference/dex/vector-stores/search-in-vector-stores-file"}]},{"group":"Extract","pages":[{"title":"Create Extract Job","description":"Create a new extract job.\n\nThis endpoint creates an extraction job that runs **single-pass** LLM extraction\nfrom a parse result or vector store search context. For agentic (decompose / ReAct)\nextraction, use ``POST …/research`` instead; requests with ``use_agentic=True`` are rejected.\n\nArgs:\n request: Extract job request containing source_id and parameters\n\nReturns:\n JobEntity: The created job entity\n\nRaises:\n HTTPException: If source not found or workflow startup fails","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/extract","href":"/reference/dex/extract/create-extract-job"},{"title":"Get Extraction","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/extract/{extraction_id}/result","href":"/reference/dex/extract/get-extraction"},{"title":"List Extractions","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/extract/results","href":"/reference/dex/extract/list-extractions"}]},{"group":"Research","pages":[{"title":"Create Research Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/research","href":"/reference/dex/research/create-research-job"},{"title":"List Research Results","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/research/results","href":"/reference/dex/research/list-research-results"}]},{"group":"Jobs","pages":[{"title":"Get Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/jobs/{job_id}","href":"/reference/dex/jobs/get-job"},{"title":"List Jobs","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/jobs","href":"/reference/dex/jobs/list-jobs"},{"title":"Cancel Job","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/jobs/{job_id}/cancel","href":"/reference/dex/jobs/cancel-job"},{"title":"Stream Job Updates","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/jobs/{job_id}/updates","href":"/reference/dex/jobs/stream-job-updates"}]},{"group":"Indexes","pages":[{"title":"List Indexes","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/indexes","href":"/reference/dex/indexes/list-indexes"},{"title":"Create Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/indexes","href":"/reference/dex/indexes/create-index"},{"title":"Get Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/indexes/{index_id}","href":"/reference/dex/indexes/get-index"},{"title":"Delete Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/indexes/{index_id}","href":"/reference/dex/indexes/delete-index"},{"title":"Batch Upsert Files To Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/indexes/{index_id}/files","href":"/reference/dex/indexes/batch-upsert-files-to-index"},{"title":"Batch Delete Files From Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/indexes/{index_id}/files","href":"/reference/dex/indexes/batch-delete-files-from-index"},{"title":"Search Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/indexes/{index_id}/search","href":"/reference/dex/indexes/search-index"},{"title":"Navigate Index","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/indexes/{index_id}/navigate","href":"/reference/dex/indexes/navigate-index"}]},{"group":"Data sources","pages":[{"title":"List Project Data Sources","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/data-sources","href":"/reference/dex/data-sources/list-project-data-sources"},{"title":"Link Project Data Source","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/data-sources","href":"/reference/dex/data-sources/link-project-data-source"},{"title":"Get Project Data Source","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json get /v1/projects/{project_id}/data-sources/{data_source_id}","href":"/reference/dex/data-sources/get-project-data-source"},{"title":"Unlink Project Data Source","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json delete /v1/projects/{project_id}/data-sources/{data_source_id}","href":"/reference/dex/data-sources/unlink-project-data-source"},{"title":"Resync Data Source Deltas","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/projects/{project_id}/data-sources/{data_source_id}/resync","href":"/reference/dex/data-sources/resync-data-source-deltas"}]},{"group":"Webhooks","pages":[{"title":"Ingest Data Sources Change Event","deprecated":null,"version":null,"openapi":"https://dex.sgp.scale.com/openapi.json post /v1/webhooks/data-sources","href":"/reference/dex/webhooks/ingest-data-sources-change-event"}]}]}]},{"version":"V4 (legacy)","pages":[{"title":"V4 (legacy)","href":"/home"}]}]},"title":"Search in vector store's file - Scale AI","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}