Builds the index using the specified training configuration. Required before efficient querying.
Prior to calling this, all queries will be conducted using encrypted exhaustive search.
After, they will be conducted using encrypted ANN search.
def train(self, n_lists: int = None, batch_size: int = None, max_iters: int = None, tolerance: float = None, max_memory: int = None)
Parameters
Parameter
Type
Default
Description
n_lists
int
None
(Optional) Number of inverted index lists to create in the index. When None, auto-determines based on the number of vectors in the index (equivalent to 0).
batch_size
int
None
(Optional) Size of each batch for training. When None, defaults to 2048.
max_iters
int
None
(Optional) Maximum number of iterations for training. When None, defaults to 100.
tolerance
float
None
(Optional) Convergence tolerance for training. When None, defaults to 1e-6.
max_memory
int
None
(Optional) Maximum memory to use for training. When None, defaults to 0 (no limit).
There must be at least 2 * n_lists or 10,000 (whichever is greater) vector embeddings in the index prior to calling this function.
Exceptions
ValueError
Raises an exception if the index was not created or loaded yet.
RuntimeError
Raises an exception if there are not enough vector embeddings in the index for training (must be at least 2 * n_lists).
Raises an exception if the index could not be trained.
Example Usage
# Load indexindex = client.load_index( index_name=index_name, index_key=index_key)# Train the index with custom settingsindex.train( batch_size=128, max_iters=10, tolerance=1e-4)# Train with default settings (auto-selected configuration)index.train()
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"CyborgDB Docs","description":"Documentation for CyborgDB, the Confidential Vector Database.","colors":{"primary":"#10A3AE","light":"#5DC3CA","dark":"#314656"},"logo":{"light":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/logo/cyborgdb-docs-light.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=bbb0a6cc479d27f584896c628b66b73d","dark":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/logo/cyborgdb-docs-dark.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=fe902ba2a6f1b755aa4d58a35c06612e"},"favicon":"https://mintcdn.com/cyborg/o5z3-JbkwPXf99Si/images/favicon-light.svg?fit=max\u0026auto=format\u0026n=o5z3-JbkwPXf99Si\u0026q=85\u0026s=ea79e6f8996aea0934264cb309ca5795","navbar":{"links":[{"href":"/quickstart","label":"Quickstart"},{"href":"https://www.cyborg.co/contact","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://cyborgdb.co/new"}},"footer":{"socials":{"x":"https://x.com/CyborgHQ","github":"https://github.com/cyborginc","linkedin":"https://linkedin.com/company/cyborginc","website":"https://www.cyborg.co"}},"search":{"prompt":"Search documentation..."},"seo":{"metatags":{"description":"Documentation for CyborgDB, the Confidential Vector Database","keywords":"vector database, encryption, confidential computing, AI, RAG"}},"integrations":{"plausible":{"domain":"docs.cyborg.co","server":"d1w0psmo3bkh8z.cloudfront.net"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cyborg","hasAudioNarration":false,"actualSubdomain":"cyborg","customDomains":["docs.cyborg.co"],"gitSource":{"type":"github","owner":"cyborginc","repo":"cyborgdb-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb40ad988193f87805845e","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"CyborgDB Service","count":109},{"language":"default","tag":"Encrypted Index","count":47},{"language":"default","tag":"Guides","count":43},{"language":"default","tag":"CyborgDB Embedded","count":37},{"language":"default","tag":"Client","count":31},{"language":"default","tag":"Python SDK Reference","count":22},{"language":"default","tag":"REST API Reference","count":21},{"language":"default","tag":"Introduction","count":20},{"language":"default","tag":"Go SDK Reference","count":20},{"language":"default","tag":"JS/TS SDK Reference","count":20}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@cyborg.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"div[class*=\"mt-8\"][class*=\"lg:mt-0\"][class*=\"flex\"][class*=\"xl:hidden\"]{display:none!important}"}]}
{"page":{"pagePath":"versions/v0.16.x/embedded/python/encrypted-index/train","slug":"/versions/v0.16.x/embedded/python/encrypted-index/train","pageMetadata":{"title":"Train Index","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/embedded/python/encrypted-index/train"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,em:`em`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Table,Tip}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Builds the index using the specified training configuration. Required before efficient querying.\nPrior to calling this, all queries will be conducted using encrypted exhaustive search.\nAfter, they will be conducted using encrypted ANN search.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` train`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` n_lists`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`int`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` batch_size`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`int`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` max_iters`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`int`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` tolerance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`float`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` max_memory`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`int`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`parameters`,children:`Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Default`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`n_lists`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`int`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`None`})}),_jsxs(_components.td,{children:[_jsx(_components.em,{children:`(Optional)`}),` Number of inverted index lists to create in the index. When `,_jsx(_components.code,{children:`None`}),`, auto-determines based on the number of vectors in the index (equivalent to `,_jsx(_components.code,{children:`0`}),`).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`batch_size`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`int`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`None`})}),_jsxs(_components.td,{children:[_jsx(_components.em,{children:`(Optional)`}),` Size of each batch for training. When `,_jsx(_components.code,{children:`None`}),`, defaults to `,_jsx(_components.code,{children:`2048`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`max_iters`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`int`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`None`})}),_jsxs(_components.td,{children:[_jsx(_components.em,{children:`(Optional)`}),` Maximum number of iterations for training. When `,_jsx(_components.code,{children:`None`}),`, defaults to `,_jsx(_components.code,{children:`100`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tolerance`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`float`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`None`})}),_jsxs(_components.td,{children:[_jsx(_components.em,{children:`(Optional)`}),` Convergence tolerance for training. When `,_jsx(_components.code,{children:`None`}),`, defaults to `,_jsx(_components.code,{children:`1e-6`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`max_memory`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`int`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`None`})}),_jsxs(_components.td,{children:[_jsx(_components.em,{children:`(Optional)`}),` Maximum memory to use for training. When `,_jsx(_components.code,{children:`None`}),`, defaults to `,_jsx(_components.code,{children:`0`}),` (no limit).`]})]})]})]}),`\n`,_jsxs(Tip,{children:[`There must be at least `,_jsx(_components.code,{children:`2 * n_lists`}),` or `,_jsx(_components.code,{children:`10,000`}),` (whichever is greater) vector embeddings in the index prior to calling this function.`]}),`\n`,_jsx(Heading,{level:`3`,id:`exceptions`,children:`Exceptions`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`ValueError`,id:`valueerror`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Raises an exception if the index was not created or loaded yet.`}),`\n`]})}),_jsx(Accordion,{title:`RuntimeError`,id:`runtimeerror`,children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Raises an exception if there are not enough vector embeddings in the index for training (must be at least `,_jsx(_components.code,{children:`2 * n_lists`}),`).`]}),`\n`,_jsx(_components.li,{children:`Raises an exception if the index could not be trained.`}),`\n`]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`example-usage`,children:`Example Usage`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Load index`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client.load_index(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` index_name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_name, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` index_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_key`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Train the index with custom settings`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index.train(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` batch_size`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`128`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` max_iters`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` tolerance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1e-4`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Train with default settings (auto-selected configuration)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index.train()`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Train Index","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/embedded/python/encrypted-index/train"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Parameters","slug":"parameters","depth":3,"children":[]},{"title":"Exceptions","slug":"exceptions","depth":3,"children":[]},{"title":"Example Usage","slug":"example-usage","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cyborg","siteName":"CyborgDB Docs","title":"Train Index - CyborgDB Docs","navMaps":{"firstHrefInVersion":{"v0.18.x":{"href":"/versions/latest/embedded/python/encrypted-index/train","matchLevel":1},"v0.17.x":{"href":"/versions/v0.17.x/embedded/python/encrypted-index/train","matchLevel":1,"noindex":true},"v0.16.x":{"href":"/versions/v0.16.x/embedded/python/encrypted-index/train","matchLevel":0},"v0.15.x":{"href":"/versions/v0.15.x/embedded/python/encrypted-index/train","matchLevel":1,"noindex":true}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T18:55:56.619Z","originalFileLocation":"versions/v0.16.x/embedded/python/encrypted-index/train.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=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head name=\"keywords\" content=\"vector database, encryption, confidential computing, AI, RAG\">\u003cmeta data-mint-head name=\"application-name\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_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/cyborg/nIdBwrMtVXG498vp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Train Index - CyborgDB Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cyborg.co/versions/v0.16.x/embedded/python/encrypted-index/train\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cyborg.mintlify.site/_mintlify/api/og/v2?division=Encrypted+Index\u0026amp;title=Train+Index\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=f094fbeca56ca6e7edd6681504e98e88ea4f7f1517f2851441ed3ac18b394c4a\">\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=\"Train Index - CyborgDB Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Documentation for CyborgDB, the Confidential Vector Database\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cyborg.mintlify.site/_mintlify/api/og/v2?division=Encrypted+Index\u0026amp;title=Train+Index\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=f094fbeca56ca6e7edd6681504e98e88ea4f7f1517f2851441ed3ac18b394c4a\">\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/cyborg/nIdBwrMtVXG498vp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CyborgDB Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10A3AE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cyborg.co/versions/v0.16.x/embedded/python/encrypted-index/train\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/versions/v0.16.x/embedded/python/encrypted-index/train.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CyborgDB Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CyborgDB Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/versions/v0.16.x/embedded/python/encrypted-index/train.md","siteName":"CyborgDB Docs","nav":{"global":null,"versions":[{"version":"v0.18.x","tag":"Latest","pages":[{"title":"v0.18.x","href":"/versions/latest/embedded/python/encrypted-index/train"}]},{"version":"v0.17.x","pages":[{"title":"v0.17.x","href":"/versions/v0.17.x/embedded/python/encrypted-index/train"}]},{"version":"v0.16.x","tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":""}]},{"tab":"CyborgDB Service","dropdowns":[{"dropdown":"Guides","icon":"book","groups":[{"group":"CyborgDB Service","pages":[{"title":"CyborgDB Service","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/about"},{"title":"Python Service Quickstart","sidebarTitle":"Python Quickstart","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/quickstart-python"},{"title":"Docker Service Quickstart","sidebarTitle":"Docker Quickstart","mode":"wide","href":"/versions/v0.16.x/service/guides/intro/quickstart-docker"}]},{"group":"Encrypted Indexes","pages":[{"title":"Introduction to Encrypted Indexes","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/introduction"},{"title":"Create Client","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/create-client"},{"title":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/create-index"},{"title":"Load an Existing Encrypted Index","sidebarTitle":"Load Existing Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/load-index"},{"title":"List Encrypted Indexes","sidebarTitle":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/list-indexes"},{"title":"Delete an Encrypted Index","sidebarTitle":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/guides/encrypted-indexes/delete-index"}]},{"group":"Data Operations","pages":[{"title":"Add Items to an Encrypted Index","sidebarTitle":"Add Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/add-items"},{"title":"Query Encrypted Index","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/query"},{"title":"Metadata Filtering","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/metadata-filtering"},{"title":"Get Encrypted Items","sidebarTitle":"Get Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/get-items"},{"title":"Delete Encrypted Items","sidebarTitle":"Delete Items","mode":"wide","href":"/versions/v0.16.x/service/guides/data-operations/delete-items"}]},{"group":"Advanced","pages":[{"title":"Managing Encryption Keys","href":"/versions/v0.16.x/service/guides/advanced/managing-keys"},{"title":"Environment Variables","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/env-vars"},{"title":"Configure an Encrypted Index","sidebarTitle":"Configure Index","href":"/versions/v0.16.x/service/guides/advanced/configure-index"},{"title":"Train an Encrypted Index","sidebarTitle":"Train Index","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/train-index"},{"title":"CyborgDB Usage Telemetry","sidebarTitle":"Usage Telemetry","mode":"wide","href":"/versions/v0.16.x/service/guides/advanced/usage-telemetry"}]}]},{"dropdown":"REST API Reference","icon":"rectangle-terminal","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB REST API Reference","sidebarTitle":"REST API Introduction","mode":"wide","href":"/versions/v0.16.x/service/rest-api/introduction"}]},{"group":"Client","pages":[{"title":"Health Check","mode":"wide","api":"GET /v1/health","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/get-health"},{"title":"Create Index","mode":"wide","api":"POST /v1/indexes/create","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/create-index"},{"title":"List Indexes","mode":"wide","api":"GET /v1/indexes/list","playground":"simple","href":"/versions/v0.16.x/service/rest-api/client/list-indexes"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert Vectors","mode":"wide","api":"POST /v1/vectors/upsert","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/upsert"},{"title":"Query Vectors","mode":"wide","api":"POST /v1/vectors/query","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/query"},{"title":"Train Index","mode":"wide","api":"POST /v1/indexes/train","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/train"},{"title":"Get Vectors","mode":"wide","api":"POST /v1/vectors/get","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/get"},{"title":"Delete Vectors","mode":"wide","api":"POST /v1/vectors/delete","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","api":"POST /v1/indexes/delete","playground":"simple","href":"/versions/v0.16.x/service/rest-api/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Describe Index","mode":"wide","api":"POST /v1/indexes/describe","playground":"simple","href":"/versions/v0.16.x/service/rest-api/getters/describe-index"},{"title":"Get Vector Count","mode":"wide","api":"POST /v1/vectors/num_vectors","playground":"simple","href":"/versions/v0.16.x/service/rest-api/getters/get-vector-count"}]}]},{"dropdown":"Python SDK Reference","icon":"python","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - Python SDK Reference","sidebarTitle":"Python SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/python-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/python-sdk/getters"},{"title":"Types","href":"/versions/v0.16.x/service/python-sdk/types"}]}]},{"dropdown":"JS/TS SDK Reference","icon":"js","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - JavaScript/TypeScript SDK Reference","sidebarTitle":"JS/TS SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/js-ts-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/js-ts-sdk/getters"},{"title":"Types","href":"/versions/v0.16.x/service/js-ts-sdk/types"}]}]},{"dropdown":"Go SDK Reference","icon":"golang","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - Go SDK Reference","sidebarTitle":"Go SDK Introduction","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/client"},{"title":"Get Health","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/get-health"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/list-indexes"},{"title":"Generate Key","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/client/generate-key"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/query"},{"title":"Train","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/get"},{"title":"List IDs","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/list-ids"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/encrypted-index/delete-index"}]},{"group":"Types \u0026 Helpers","pages":[{"title":"Getters","href":"/versions/v0.16.x/service/go-sdk/getters"},{"title":"Types","mode":"wide","href":"/versions/v0.16.x/service/go-sdk/types"}]}]}]},{"tab":"CyborgDB Embedded","dropdowns":[{"dropdown":"Guides","icon":"book","groups":[{"group":"Intro","pages":[{"title":"CyborgDB Embedded","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/guides/intro/about"},{"title":"CyborgDB Embedded Quickstart","sidebarTitle":"Quickstart","mode":"wide","href":"/versions/v0.16.x/embedded/guides/intro/quickstart"}]},{"group":"Encrypted Indexes","pages":[{"title":"Introduction to Encrypted Indexes","sidebarTitle":"Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/introduction"},{"title":"Create Client","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-client"},{"title":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index"},{"title":"Load an Existing Encrypted Index","sidebarTitle":"Load Existing Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/load-index"},{"title":"List Encrypted Indexes","sidebarTitle":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/list-indexes"},{"title":"Train an Encrypted Index","sidebarTitle":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/train-index"},{"title":"Delete an Encrypted Index","sidebarTitle":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/delete-index"}]},{"group":"Data Operations","pages":[{"title":"Add Items to an Encrypted Index","sidebarTitle":"Add Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/add-items"},{"title":"Query Encrypted Index","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/query"},{"title":"Metadata Filtering","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/metadata-filtering"},{"title":"Get Encrypted Items","sidebarTitle":"Get Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/get-items"},{"title":"Delete Encrypted Items","sidebarTitle":"Delete Items","mode":"wide","href":"/versions/v0.16.x/embedded/guides/data-operations/delete-items"}]},{"group":"Advanced","pages":[{"title":"Managing Encryption Keys","href":"/versions/v0.16.x/embedded/guides/advanced/managing-keys"},{"title":"Configure an Encrypted Index","sidebarTitle":"Configure Index","href":"/versions/v0.16.x/embedded/guides/advanced/configure-index"},{"title":"CyborgDB Usage Telemetry","sidebarTitle":"Usage Telemetry","mode":"wide","href":"/versions/v0.16.x/embedded/guides/advanced/usage-telemetry"}]}]},{"dropdown":"Python API Reference","icon":"python","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB Embedded - Python API Reference","sidebarTitle":"Python API Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/python/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/client"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/list-indexes"},{"title":"Logger","mode":"wide","href":"/versions/v0.16.x/embedded/python/client/logger"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/upsert"},{"title":"Query","mode":"wide","description":null,"href":"/versions/v0.16.x/embedded/python/encrypted-index/query"},{"title":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/train"},{"title":"Get","mode":"wide","description":null,"href":"/versions/v0.16.x/embedded/python/encrypted-index/get"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/python/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Getter Functions","href":"/versions/v0.16.x/embedded/python/getters"},{"title":"Types","href":"/versions/v0.16.x/embedded/python/types"}]}]},{"dropdown":"C++ API Reference","icon":"brackets-curly","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB Embedded - C++ API Reference","sidebarTitle":"C++ API Introduction","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/introduction"}]},{"group":"Client","pages":[{"title":"Client","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/client"},{"title":"Create Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/create-index"},{"title":"Load Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/load-index"},{"title":"List Indexes","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/list-indexes"},{"title":"Logger","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/client/logger"}]},{"group":"Encrypted Index","pages":[{"title":"Upsert","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/upsert"},{"title":"Query","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/query"},{"title":"Train Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/train"},{"title":"Get","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/get"},{"title":"Delete","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/delete"},{"title":"Delete Index","mode":"wide","href":"/versions/v0.16.x/embedded/cpp/encrypted-index/delete-index"}]},{"group":"Types \u0026 Getters","pages":[{"title":"Getter Functions","href":"/versions/v0.16.x/embedded/cpp/getters"},{"title":"Types","href":"/versions/v0.16.x/embedded/cpp/types"}]}]}]},{"tab":"Integrations","dropdowns":[{"dropdown":"Integrations","icon":"puzzle-piece","groups":[{"group":"Overview","pages":[{"title":"CyborgDB Integrations","sidebarTitle":"Integrations","mode":"wide","href":"/versions/v0.16.x/integrations/about"}]}]},{"dropdown":"LangChain","icon":"link","groups":[{"group":"Introduction","pages":[{"title":"CyborgDB - LangChain Integration","sidebarTitle":"LangChain Introduction","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/introduction"}]},{"group":"CyborgVectorStore","pages":[{"title":"__init__","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/init"},{"title":"add_texts","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/add_texts"},{"title":"add_documents","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/add_documents"},{"title":"get","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/get"},{"title":"list_ids","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/list_ids"},{"title":"delete","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/delete"},{"title":"similarity_search","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search"},{"title":"similarity_search_with_score","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search_with_score"},{"title":"similarity_search_by_vector","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/similarity_search_by_vector"},{"title":"max_marginal_relevance_search","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/max_marginal_relevance_search"},{"title":"from_texts","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/from_texts"},{"title":"from_documents","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/from_documents"},{"title":"as_retriever","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/as_retriever"},{"title":"generate_key","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/generate_key"},{"title":"get_embeddings","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/client/get_embeddings"}]},{"group":"Types","pages":[{"title":"Types","mode":"wide","href":"/versions/v0.16.x/integrations/langchain/types"}]}]}]}]},{"version":"v0.15.x","pages":[{"title":"v0.15.x","href":"/versions/v0.15.x/embedded/python/encrypted-index/train"}]}]},"basePath":"","title":"Train Index - CyborgDB Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}