To create an encrypted index, you need to specify an index name (must be unique) and an index key:
import cyborgdb_core as cyborgdbimport secrets# Using `threadsafememory` storage for this exampleindex_location = cyborgdb.DBConfig("threadsafememory") config_location = cyborgdb.DBConfig("threadsafememory")# Get your API keyapi_key = "your_api_key_here" # Replace with your actual API key# Create a clientclient = cyborgdb.Client( api_key=api_key, index_location=index_location, config_location=config_location)# Generate an encryption key for the indexindex_key = secrets.token_bytes(32)# Create an encrypted indexindex = client.create_index( index_name="my_index", index_key=index_key)
#include "cyborgdb_core/client.hpp"#include "cyborgdb_core/encrypted_index.hpp"#include <openssl/rand.h>#include <array>// Using `threadsafememory` storage for this examplecyborg::DBConfig index_location(cyborg::Location::kThreadSafeMemory);cyborg::DBConfig config_location(cyborg::Location::kThreadSafeMemory);cyborg::DBConfig contents_location(cyborg::Location::kThreadSafeMemory);// Get your API keystd::string api_key = "your_api_key_here"; // Replace with your actual API key// Create a clientcyborg::Client client(api_key, index_location, config_location, contents_location, 0, cyborg::kNone);// Generate a 32-byte secure encryption key using OpenSSLstd::array<uint8_t, 32> index_key;if (RAND_bytes(index_key.data(), index_key.size()) != 1) { throw std::runtime_error("Failed to generate secure random key");}// Create an encrypted indexauto index = client.CreateIndex("my_index", index_key);
This creates a new encrypted index with the IVFSQ (16-bit) type by default. For more details on IVFSQ and other index options, see Configure an Encrypted Index.
The example above creates a random 32 byte (256-bit) index key.
This is fine for evaluation purposes, but for production use, we recommend that you use an HSM or KMS solution.
For more details, see Managing Encryption Keys.
Automatic Embedding Generation
This feature is only available in Python. To use it, use pip install cyborgdb-core[embeddings]
In the Python version of CyborgDB, you can enable automatic embedding generation for the encrypted index by setting embedding_model in create_index():
Python
import cyborgdb_core as cyborgdbimport secrets# Using `threadsafememory` storage for this exampleindex_location = cyborgdb.DBConfig("threadsafememory")config_location = cyborgdb.DBConfig("threadsafememory")items_location = cyborgdb.DBConfig("threadsafememory")# Get your API keyapi_key = "your_api_key_here" # Replace with your actual API key# Create a clientclient = cyborgdb.Client( api_key=api_key, index_location=index_location, config_location=config_location, items_location=items_location)# Generate an encryption key for the indexindex_key = secrets.token_bytes(32)# Set embedding model (from HuggingFace)embedding_model = "all-MiniLM-L6-v2"# Create an encrypted index with managed embedding generationindex = client.create_index( index_name="my_index", index_key=index_key, embedding_model=embedding_model)
API Reference
For more information on creating encrypted indexes, refer to the API reference:
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/guides/encrypted-indexes/create-index","slug":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index","pageMetadata":{"title":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index"},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,CodeGroup,Heading,Tip,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To create an encrypted index, you need to specify an index name (must be unique) and an index key:`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,icon:`python`,numberOfLines:`25`,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:`25`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb_core `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` secrets`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:\"# Using `threadsafememory` storage for this example\"})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.DBConfig(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"threadsafememory\"`}),_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\":`#D4D4D4`},children:`config_location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.DBConfig(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"threadsafememory\"`}),_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:`# Get your API key`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Replace with your actual API key`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Create a client`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.Client(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` index_location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_location, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` config_location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`config_location`})]}),`\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:`# Generate an encryption key for the index`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` secrets.token_bytes(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`32`}),_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:`# Create an encrypted 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.create_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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"my_index\"`}),_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:` 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(CodeBlock,{filename:`C++`,icon:`brackets-curly`,numberOfLines:`24`,language:`cpp`,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:`cpp`,children:_jsxs(_components.code,{language:`cpp`,numberOfLines:`24`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`#include`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"cyborgdb_core/client.hpp\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`#include`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"cyborgdb_core/encrypted_index.hpp\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`#include`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \u003copenssl/rand.h>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`#include`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \u003carray>`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:\"// Using `threadsafememory` storage for this example\"})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`DBConfig`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` index_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`Location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`kThreadSafeMemory`}),_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\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`DBConfig`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` config_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`Location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`kThreadSafeMemory`}),_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\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`DBConfig`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` contents_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`Location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`kThreadSafeMemory`}),_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:`// Get your API key`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`std`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::string api_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Replace with your actual API key`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Create a client`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`Client`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`api_key`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`index_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`config_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`contents_location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`cyborg`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`kNone`}),_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:`// Generate a 32-byte secure encryption key using OpenSSL`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:`std`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::array`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`uint8_t`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`32`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` index_key;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`RAND_bytes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`index_key`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(), `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`index_key`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`size`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`!=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` throw`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` std`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`::`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`runtime_error`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Failed to generate secure random key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\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:`// Create an encrypted index`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`auto`}),_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\":`#9CDCFE`},children:` client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`CreateIndex`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"my_index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, index_key);`})]}),`\n`]})})})]}),`\n`,_jsxs(_components.p,{children:[`This creates a new encrypted index with the IVFSQ (16-bit) type by default. For more details on IVFSQ and other index options, see `,_jsx(_components.a,{href:`/versions/v0.16.x/embedded/guides/advanced/configure-index`,children:`Configure an Encrypted Index`}),`.`]}),`\n`,_jsxs(Warning,{children:[`The example above creates a random 32 byte (256-bit) index key.\nThis is fine for evaluation purposes, but for production use, we recommend that you use an HSM or KMS solution.\nFor more details, see `,_jsx(_components.a,{href:`/versions/v0.16.x/embedded/guides/advanced/managing-keys`,children:`Managing Encryption Keys`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`automatic-embedding-generation`,children:`Automatic Embedding Generation`}),`\n`,_jsxs(Tip,{children:[`This feature is only available in Python. To use it, use `,_jsx(_components.code,{children:`pip install cyborgdb-core[embeddings]`})]}),`\n`,_jsxs(_components.p,{children:[`In the Python version of CyborgDB, you can enable automatic embedding generation for the encrypted index by setting `,_jsx(_components.code,{children:`embedding_model`}),` in `,_jsx(_components.code,{children:`create_index()`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:`Python`,icon:`python`,numberOfLines:`31`,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:`31`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb_core `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` secrets`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:\"# Using `threadsafememory` storage for this example\"})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.DBConfig(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"threadsafememory\"`}),_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\":`#D4D4D4`},children:`config_location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.DBConfig(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"threadsafememory\"`}),_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\":`#D4D4D4`},children:`items_location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.DBConfig(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"threadsafememory\"`}),_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:`# Get your API key`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Replace with your actual API key`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Create a client`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` cyborgdb.Client(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` index_location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_location, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` config_location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`config_location, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` items_location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`items_location`})]}),`\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:`# Generate an encryption key for the index`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`index_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` secrets.token_bytes(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`32`}),_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:`# Set embedding model (from HuggingFace)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`embedding_model `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"all-MiniLM-L6-v2\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Create an encrypted index with managed embedding generation`})}),`\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.create_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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"my_index\"`}),_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:` 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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` embedding_model`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`embedding_model`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`api-reference`,children:`API Reference`}),`\n`,_jsx(_components.p,{children:`For more information on creating encrypted indexes, refer to the API reference:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Python API Reference`,href:`/versions/v0.16.x/embedded/python/client/create-index`,icon:`python`,children:_jsxs(_components.p,{children:[`API reference for `,_jsx(_components.code,{children:`create_index()`}),` in Python`]})}),_jsx(Card,{title:`C++ API Reference`,href:`/versions/v0.16.x/embedded/cpp/client/create-index`,icon:`brackets-curly`,children:_jsxs(_components.p,{children:[`API reference for `,_jsx(_components.code,{children:`CreateIndex()`}),` in C++`]})})]})]})}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":"Create a New Encrypted Index","sidebarTitle":"Create New Index","mode":"wide","noindex":true,"description":null,"href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Automatic Embedding Generation","slug":"automatic-embedding-generation","depth":2,"children":[]},{"title":"API Reference","slug":"api-reference","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cyborg","siteName":"CyborgDB Docs","title":"Create a New Encrypted Index - CyborgDB Docs","navMaps":{"firstHrefInVersion":{"v0.18.x":{"href":"/versions/latest/embedded/guides/encrypted-indexes/create-index","matchLevel":1},"v0.17.x":{"href":"/versions/v0.17.x/embedded/guides/encrypted-indexes/create-index","matchLevel":1,"noindex":true},"v0.16.x":{"href":"/versions/v0.16.x/embedded/guides/encrypted-indexes/create-index","matchLevel":0},"v0.15.x":{"href":"/versions/v0.15.x/embedded/guides/encrypted-indexes/create-index","matchLevel":1,"noindex":true}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T18:55:56.635Z","originalFileLocation":"versions/v0.16.x/embedded/guides/encrypted-indexes/create-index.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=\"Create a New Encrypted 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/guides/encrypted-indexes/create-index\">\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+Indexes\u0026amp;title=Create+a+New+Encrypted+Index\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=ad2bc81eb56dd32c8095663f1abdc17a63829ceb21b70d9a0911b69c730ba24e\">\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=\"Create a New Encrypted 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+Indexes\u0026amp;title=Create+a+New+Encrypted+Index\u0026amp;theme=0150e3d458a38d4dcc0f6e24\u0026amp;signature=ad2bc81eb56dd32c8095663f1abdc17a63829ceb21b70d9a0911b69c730ba24e\">\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/guides/encrypted-indexes/create-index\">\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/guides/encrypted-indexes/create-index.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/guides/encrypted-indexes/create-index.md","siteName":"CyborgDB Docs","nav":{"global":null,"versions":[{"version":"v0.18.x","tag":"Latest","pages":[{"title":"v0.18.x","href":"/versions/latest/embedded/guides/encrypted-indexes/create-index"}]},{"version":"v0.17.x","pages":[{"title":"v0.17.x","href":"/versions/v0.17.x/embedded/guides/encrypted-indexes/create-index"}]},{"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","description":null,"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","description":null,"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","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","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/guides/encrypted-indexes/create-index"}]}]},"basePath":"","title":"Create a New Encrypted Index - CyborgDB Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}