Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema; the server-managed id field may be included as returned or omitted. New fields may be added at any object depth while retaining existing fields and their settings. Field descriptions are the exception: an omitted field description keeps the stored one, an empty string clears it, and a new value replaces it without reindexing.
indexConfigs
IndexConfigs · object | null
required
Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {"type":"keyword"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.
Show child attributes
description
string | null
Maximum string length: 255
tags
object | null
Replaces the entire collection metadata map; {} clears it. Up to five entries.
Show child attributes
snapshotRetentionInDays
integer | null
Number of days to retain committed snapshots.
Required range: 1 <= x <= 31
Response
Updated collection
collection
CollectionResponse · object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LambdaDB Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/logo/light.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=3984578842930966eb2d9d05766af2cd","dark":"https://mintcdn.com/lambdadb/p3ZLnnGiGP71YxJM/logo/dark.svg?fit=max\u0026auto=format\u0026n=p3ZLnnGiGP71YxJM\u0026q=85\u0026s=18498f8b90cd8979b463acbae342f9b1"},"favicon":"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/favicon.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=6f7e3b6dbe311b4da3a87224c799b276","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:support@lambdadb.ai","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/lambdadb","linkedin":"https://www.linkedin.com/company/lambdadb","x":"https://x.com/lambdadbai","reddit":"https://www.reddit.com/r/vectorlake","slack":"https://lambdadbcommunity.slack.com/join/shared_invite/zt-3sg7565zm-sCTW3odRkEQt~auWUVVsTw"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lambdadb","hasAudioNarration":false,"actualSubdomain":"lambdadb","customDomains":["docs.lambdadb.ai"],"gitSource":{"type":"github","owner":"lambdadb","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6aedc24bc42bb37e7408153b","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Guides","count":38},{"language":"default","tag":"Reference","count":26},{"language":"default","tag":"APIs","count":25},{"language":"default","tag":"Documents","count":14},{"language":"default","tag":"Collections","count":11},{"language":"default","tag":"Search","count":10},{"language":"default","tag":"Branches, tags \u0026 aliases","count":10},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Migrations","count":6},{"language":"default","tag":"Query","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/api/endpoint/collection-configure","slug":"/reference/api/endpoint/collection-configure","pageMetadata":{"title":"Configure a collection","openapi":"patch /collections/{collectionName}","description":"Configure a collection.","href":"/reference/api/endpoint/collection-configure"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Configure a collection.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Configure a collection","openapi":"patch /collections/{collectionName}","description":"Configure a collection.","href":"/reference/api/endpoint/collection-configure"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["collections"],"operationId":"updateCollection","description":"Configure a collection.","security":["a937f43c-fbc5-4a94-b229-d11306ef28ff"],"parameters":["d8112457-9ef4-461d-9ec2-9fc64f219c3b"],"requestBody":"b373023d-aa3c-45bd-9efa-e3227ce2c3bc","responses":{"200":"c6917eea-fc4f-4cba-b02b-5d9b4a3968db","400":"a1cd269b-c67d-4e99-a7fa-85ad95a5b185","401":"4704743e-ab92-4130-82dc-ddad25f494ca","404":"8b76bae7-63f3-4e3f-ae26-4c36104a4a8d","409":"e2488749-5466-4c17-85d9-7e88205899f9","413":"668d0b24-170e-443f-96c0-98a3f1cc86dc","429":"adb7e67b-f697-4e96-b56a-469ed87f7d1b","500":"0a867257-4b6f-412f-bed2-e9b43647091d","502":"89405e59-f237-4b3a-a6ec-85ab923aed1d","503":"77dbc072-de78-4a8b-a404-41645cfb9acb","504":"31f8fbb5-4534-47b0-81bd-3e97a008bb3e"},"summary":"Configure a Collection","method":"patch","type":"path","servers":["7431bbc0-1b39-40d2-b54d-415419b0c4d9"],"path":"/collections/{collectionName}","baseUrlOptions":["https://{projectHost}"],"title":"Configure a Collection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d8112457-9ef4-461d-9ec2-9fc64f219c3b":{"in":"path","name":"collectionName","description":"Collection name.","required":true,"schema":{"type":"string","isRequired":true,"description":"Collection name.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema; the server-managed id field may be included as returned or omitted. New fields may be added at any object depth while retaining existing fields and their settings. Field descriptions are the exception: an omitted field description keeps the stored one, an empty string clears it, and a new value replaces it without reindexing.","minProperties":1,"required":["indexConfigs"],"properties":{"indexConfigs":{"oneOf":[{"type":"object","title":"IndexConfigs","description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","minProperties":1,"additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"oneOf.0.indexConfigs.oneOf.0.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.0","typeLabel":"IndexConfigs · object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.indexConfigs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.indexConfigs","typeLabel":"IndexConfigs · object | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.description","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"object","description":"Replaces the entire collection metadata map; {} clears it. Up to five entries.","maxProperties":5,"additionalProperties":{"type":"string","minLength":1,"maxLength":127,"pattern":"^[^:#,]+$","description":"Must contain at least one non-whitespace character.","not":{"pattern":"^[\\u0009-\\u000d\\u001c-\\u0020\\u1680\\u2000-\\u2006\\u2008-\\u200a\\u2028\\u2029\\u205f\\u3000]*$"},"uniqueKey":"oneOf.0.tags.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.0.tags.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.0.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.tags","typeLabel":"object | null"},"snapshotRetentionInDays":{"oneOf":[{"type":"integer","description":"Number of days to retain committed snapshots.","maximum":31,"minimum":1,"uniqueKey":"oneOf.0.snapshotRetentionInDays.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"oneOf.0.snapshotRetentionInDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.snapshotRetentionInDays","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema; the server-managed id field may be included as returned or omitted. New fields may be added at any object depth while retaining existing fields and their settings. Field descriptions are the exception: an omitted field description keeps the stored one, an empty string clears it, and a new value replaces it without reindexing.","minProperties":1,"required":["description"],"properties":{"description":{"oneOf":[{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string | null"},"indexConfigs":{"oneOf":[{"type":"object","title":"IndexConfigs","description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","minProperties":1,"additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"oneOf.1.indexConfigs.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"oneOf.1.indexConfigs.oneOf.0","typeLabel":"IndexConfigs · object"},{"type":"null","uniqueKey":"oneOf.1.indexConfigs.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.indexConfigs","typeLabel":"IndexConfigs · object | null"},"tags":{"oneOf":[{"type":"object","description":"Replaces the entire collection metadata map; {} clears it. Up to five entries.","maxProperties":5,"additionalProperties":{"type":"string","minLength":1,"maxLength":127,"pattern":"^[^:#,]+$","description":"Must contain at least one non-whitespace character.","not":{"pattern":"^[\\u0009-\\u000d\\u001c-\\u0020\\u1680\\u2000-\\u2006\\u2008-\\u200a\\u2028\\u2029\\u205f\\u3000]*$"},"uniqueKey":"oneOf.1.tags.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.1.tags.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.1.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.tags","typeLabel":"object | null"},"snapshotRetentionInDays":{"oneOf":[{"type":"integer","description":"Number of days to retain committed snapshots.","maximum":31,"minimum":1,"uniqueKey":"oneOf.1.snapshotRetentionInDays.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"oneOf.1.snapshotRetentionInDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.snapshotRetentionInDays","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema; the server-managed id field may be included as returned or omitted. New fields may be added at any object depth while retaining existing fields and their settings. Field descriptions are the exception: an omitted field description keeps the stored one, an empty string clears it, and a new value replaces it without reindexing.","minProperties":1,"required":["tags"],"properties":{"tags":{"oneOf":[{"type":"object","description":"Replaces the entire collection metadata map; {} clears it. Up to five entries.","maxProperties":5,"additionalProperties":{"type":"string","minLength":1,"maxLength":127,"pattern":"^[^:#,]+$","description":"Must contain at least one non-whitespace character.","not":{"pattern":"^[\\u0009-\\u000d\\u001c-\\u0020\\u1680\\u2000-\\u2006\\u2008-\\u200a\\u2028\\u2029\\u205f\\u3000]*$"},"uniqueKey":"oneOf.2.tags.oneOf.0.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.2.tags.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.tags.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.tags","typeLabel":"object | null"},"indexConfigs":{"oneOf":[{"type":"object","title":"IndexConfigs","description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","minProperties":1,"additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"oneOf.2.indexConfigs.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"oneOf.2.indexConfigs.oneOf.0","typeLabel":"IndexConfigs · object"},{"type":"null","uniqueKey":"oneOf.2.indexConfigs.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.indexConfigs","typeLabel":"IndexConfigs · object | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.description","typeLabel":"string | null"},"snapshotRetentionInDays":{"oneOf":[{"type":"integer","description":"Number of days to retain committed snapshots.","maximum":31,"minimum":1,"uniqueKey":"oneOf.2.snapshotRetentionInDays.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"oneOf.2.snapshotRetentionInDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.snapshotRetentionInDays","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","description":"Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema; the server-managed id field may be included as returned or omitted. New fields may be added at any object depth while retaining existing fields and their settings. Field descriptions are the exception: an omitted field description keeps the stored one, an empty string clears it, and a new value replaces it without reindexing.","minProperties":1,"required":["snapshotRetentionInDays"],"properties":{"snapshotRetentionInDays":{"oneOf":[{"type":"integer","description":"Number of days to retain committed snapshots.","maximum":31,"minimum":1,"isRequired":true,"uniqueKey":"oneOf.3.snapshotRetentionInDays.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.3.snapshotRetentionInDays.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.3.snapshotRetentionInDays","typeLabel":"integer | null"},"indexConfigs":{"oneOf":[{"type":"object","title":"IndexConfigs","description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","minProperties":1,"additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"oneOf.3.indexConfigs.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"oneOf.3.indexConfigs.oneOf.0","typeLabel":"IndexConfigs · object"},{"type":"null","uniqueKey":"oneOf.3.indexConfigs.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.indexConfigs","typeLabel":"IndexConfigs · object | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.description","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"object","description":"Replaces the entire collection metadata map; {} clears it. Up to five entries.","maxProperties":5,"additionalProperties":{"type":"string","minLength":1,"maxLength":127,"pattern":"^[^:#,]+$","description":"Must contain at least one non-whitespace character.","not":{"pattern":"^[\\u0009-\\u000d\\u001c-\\u0020\\u1680\\u2000-\\u2006\\u2008-\\u200a\\u2028\\u2029\\u205f\\u3000]*$"},"uniqueKey":"oneOf.3.tags.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.3.tags.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.3.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.tags","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"metadataAndRetention":{"title":"metadataAndRetention","value":{"description":"Updated product catalog","tags":{"environment":"staging"},"snapshotRetentionInDays":14}},"clearTags":{"title":"clearTags","value":{"tags":{}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c6917eea-fc4f-4cba-b02b-5d9b4a3968db":{"description":"Updated collection","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"title":"CollectionResponse","type":"object","properties":{"projectName":{"type":"string","description":"Project name.","isRequired":true,"uniqueKey":"collection.projectName","typeLabel":"string"},"collectionName":{"type":"string","description":"Collection name.","isRequired":true,"uniqueKey":"collection.collectionName","typeLabel":"string"},"indexConfigs":{"title":"IndexConfigs","type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"collection.indexConfigs.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"collection.indexConfigs.additionalProperties","typeLabel":"object"},"minProperties":1,"description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","isRequired":true,"uniqueKey":"collection.indexConfigs","typeLabel":"IndexConfigs · object"},"description":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"collection.description","typeLabel":"string"},"tags":{"type":"object","description":"Collection metadata tags. Up to five entries.","maxProperties":5,"additionalProperties":{"type":"string","minLength":1,"maxLength":127,"pattern":"^[^:#,]+$","uniqueKey":"collection.tags.additionalProperties","typeLabel":"string"},"propertyNames":{"pattern":"^[A-Za-z0-9_.-]{1,63}$"},"isRequired":true,"uniqueKey":"collection.tags","typeLabel":"object"},"numPartitions":{"type":"integer","description":"Total number of partitions including the default partition.","isRequired":true,"uniqueKey":"collection.numPartitions","typeLabel":"integer"},"numDocs":{"type":"integer","description":"Document count in the default main branch's committed head, not a sum across branches or the count of a selected ref.","isRequired":true,"uniqueKey":"collection.numDocs","typeLabel":"integer"},"defaultBranchName":{"type":"string","enum":["main"],"isRequired":true,"uniqueKey":"collection.defaultBranchName","typeLabel":"enum\u003cstring>"},"snapshotRetentionInDays":{"type":"integer","minimum":1,"maximum":31,"default":30,"description":"Number of days to retain committed snapshots.","isRequired":true,"uniqueKey":"collection.snapshotRetentionInDays","typeLabel":"integer"},"createdAt":{"type":"integer","format":"int64","description":"Collection creation time as Unix epoch milliseconds.","isRequired":true,"uniqueKey":"collection.createdAt","typeLabel":"integer\u003cint64>"},"updatedAt":{"type":"integer","format":"int64","description":"Collection last update time as Unix epoch milliseconds.","isRequired":true,"uniqueKey":"collection.updatedAt","typeLabel":"integer\u003cint64>"},"partitionConfig":{"title":"PartitionConfig","type":"object","properties":{"fieldName":{"type":"string","description":"Partition field name.","uniqueKey":"collection.partitionConfig.fieldName","typeLabel":"string"},"dataType":{"type":"string","description":"Partition field data type.","enum":["keyword"],"uniqueKey":"collection.partitionConfig.dataType","typeLabel":"enum\u003cstring>"},"numPartitions":{"type":"integer","description":"The number of partitions.","minimum":2,"maximum":1024,"uniqueKey":"collection.partitionConfig.numPartitions","typeLabel":"integer"}},"uniqueKey":"collection.partitionConfig","typeLabel":"PartitionConfig · object"},"dataUpdatedAt":{"type":"integer","format":"int64","description":"Last data update time recorded in the default main branch's committed head, as Unix epoch milliseconds. Commits without data mutations retain the previous value, so this is not necessarily the latest head commit time. Absent before a committed head exists.","uniqueKey":"collection.dataUpdatedAt","typeLabel":"integer\u003cint64>"}},"required":["projectName","collectionName","indexConfigs","description","tags","numPartitions","numDocs","defaultBranchName","snapshotRetentionInDays","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"collection","typeLabel":"CollectionResponse · object"}},"required":["collection"],"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","value":{"collection":{"projectName":"example-project-name","collectionName":"example-collection-name","indexConfigs":{"title":{"type":"text","analyzers":["english"],"description":"Book title as printed on the cover"},"category":{"type":"keyword"},"id":{"type":"keyword"}},"description":"Product catalog","tags":{"environment":"production"},"numPartitions":1,"numDocs":1000,"defaultBranchName":"main","snapshotRetentionInDays":30,"createdAt":1788336000000,"updatedAt":1788336000000,"dataUpdatedAt":1788336060000}}}},"exampleType":"examples"}},"exampleType":"examples"},"a1cd269b-c67d-4e99-a7fa-85ad95a5b185":{"description":"Bad request","content":{"application/json":{"schema":{"title":"BadRequest","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"BadRequest · object"},"examples":{"example":{"title":"example","summary":"Example response for bad request","value":{"message":"Invalid request"}}},"exampleType":"examples"}},"exampleType":"examples"},"4704743e-ab92-4130-82dc-ddad25f494ca":{"description":"Unauthenticated","content":{"application/json":{"schema":{"title":"Unauthenticated","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"Unauthenticated · object"},"examples":{"example":{"title":"example","summary":"Example response for authentication failure","value":{"message":"Authentication failed"}}},"exampleType":"examples"}},"exampleType":"examples"},"8b76bae7-63f3-4e3f-ae26-4c36104a4a8d":{"description":"Resource not found","content":{"application/json":{"schema":{"title":"ResourceNotFound","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"ResourceNotFound · object"},"examples":{"example":{"title":"example","summary":"Example response for resource not found","value":{"message":"Resource not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"e2488749-5466-4c17-85d9-7e88205899f9":{"description":"Conditional catalog conflict. Refresh the resource state before deciding whether to retry.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"668d0b24-170e-443f-96c0-98a3f1cc86dc":{"description":"Request exceeds the Gateway transport limit. Reduce the request size or use bulk upsert when supported.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"adb7e67b-f697-4e96-b56a-469ed87f7d1b":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"TooManyRequests","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"TooManyRequests · object"},"examples":{"example":{"title":"example","summary":"Example response for too many requests","value":{"message":"Too many requests"}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Optional retry delay in seconds. Not present on every 429 response.","schema":{"type":"string"}}},"exampleType":"examples"},"0a867257-4b6f-412f-bed2-e9b43647091d":{"description":"Internal server error","content":{"application/json":{"schema":{"title":"InternalServerError","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"InternalServerError · object"},"examples":{"example":{"title":"example","summary":"Example response for internal server error","value":{"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"},"89405e59-f237-4b3a-a6ec-85ab923aed1d":{"description":"Unexpected downstream failure. A failed write response may leave its outcome uncertain.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"77dbc072-de78-4a8b-a404-41645cfb9acb":{"description":"Transient catalog or storage dependency failure. Use bounded retries where the operation permits.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"31f8fbb5-4534-47b0-81bd-3e97a008bb3e":{"description":"Gateway request deadline exceeded. A write may have been applied; verify its outcome before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a937f43c-fbc5-4a94-b229-d11306ef28ff":{"ProjectApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Project API Key.","x-speakeasy-example":"\u003cYOUR_PROJECT_API_KEY>","scopes":[],"schemeName":"ProjectApiKey"}}},"servers":{"7431bbc0-1b39-40d2-b54d-415419b0c4d9":{"url":"https://{projectHost}","description":"LambdaDB API endpoints","variables":{"projectHost":{"description":"The project-scoped URL of the API","default":"api.lambdadb.ai/projects/example-project"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Project API Key.","x-speakeasy-example":"\u003cYOUR_PROJECT_API_KEY>","scopes":[],"schemeName":"ProjectApiKey"},"schema":{"title":"x-api-key","type":"string","description":"Project API Key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ProjectApiKey","name":"x-api-key"}],"title":"ProjectApiKey"}]},"originalFileLocation":"reference/api/openapi.json"},"subdomain":"lambdadb","siteName":"LambdaDB Documentation","title":"Configure a collection - LambdaDB Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-21T09:53:36.481Z","originalFileLocation":"reference/api/endpoint/collection-configure.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=\"Configure a collection.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Configure a collection - LambdaDB Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Configure a collection.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lambdadb.mintlify.site/_mintlify/api/og/v2?division=Collections\u0026amp;title=Configure+a+collection\u0026amp;description=Configure+a+collection.\u0026amp;theme=3cd9b5ccc9d6e8e94ca23c6d\u0026amp;signature=965c0622aaf7af7f2d211ecde098c27b60c9a47dca28b344724f7bae0f2f5e39\">\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=\"Configure a collection - LambdaDB Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Configure a collection.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lambdadb.mintlify.site/_mintlify/api/og/v2?division=Collections\u0026amp;title=Configure+a+collection\u0026amp;description=Configure+a+collection.\u0026amp;theme=3cd9b5ccc9d6e8e94ca23c6d\u0026amp;signature=965c0622aaf7af7f2d211ecde098c27b60c9a47dca28b344724f7bae0f2f5e39\">\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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/api/endpoint/collection-configure.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lambdadb.ai/#organization\",\"name\":\"LambdaDB Documentation\",\"url\":\"https://docs.lambdadb.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/logo/light.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=3984578842930966eb2d9d05766af2cd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lambdadb.ai#website\",\"name\":\"LambdaDB Documentation\",\"url\":\"https://docs.lambdadb.ai\",\"publisher\":{\"@id\":\"https://docs.lambdadb.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure#webpage\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure\",\"name\":\"Configure a collection\",\"description\":\"Configure a collection.\",\"dateModified\":\"2026-04-21T09:53:36.481Z\",\"isPartOf\":{\"@id\":\"https://docs.lambdadb.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.lambdadb.ai/reference/api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Collections\",\"item\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Configure a collection\",\"item\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure#apireference\",\"headline\":\"Configure a collection\",\"name\":\"Configure a collection\",\"description\":\"Configure a collection.\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/collection-configure#webpage\"},\"dateModified\":\"2026-04-21T09:53:36.481Z\",\"publisher\":{\"@id\":\"https://docs.lambdadb.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lambdadb.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LambdaDB Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LambdaDB Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/api/endpoint/collection-configure.md","siteName":"LambdaDB Documentation","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started/overview"}]},{"tab":"Reference","groups":[{"group":"APIs","pages":[{"title":"API reference","href":"/reference/api/introduction"},{"group":"Collections","pages":[{"title":"List collections","openapi":"get /collections","href":"/reference/api/endpoint/collection-list"},{"title":"Create a collection","openapi":"post /collections","href":"/reference/api/endpoint/collection-create"},{"title":"Describe a collection","openapi":"get /collections/{collectionName}","href":"/reference/api/endpoint/collection-describe"},{"title":"Delete a collection","openapi":"delete /collections/{collectionName}","description":"Delete an existing collection.","href":"/reference/api/endpoint/collection-delete"},{"title":"Configure a collection","openapi":"patch /collections/{collectionName}","href":"/reference/api/endpoint/collection-configure"}]},{"group":"Branches, tags \u0026 aliases","pages":[{"title":"Create a branch","openapi":"post /collections/{collectionName}/branches","description":"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.","href":"/reference/api/endpoint/branch-create"},{"title":"List branches","openapi":"get /collections/{collectionName}/branches","href":"/reference/api/endpoint/branch-list"},{"title":"Delete a branch","openapi":"delete /collections/{collectionName}/branches/{branchName}","href":"/reference/api/endpoint/branch-delete"},{"title":"Create a tag","openapi":"post /collections/{collectionName}/tags","href":"/reference/api/endpoint/tag-create"},{"title":"List tags","openapi":"get /collections/{collectionName}/tags","href":"/reference/api/endpoint/tag-list"},{"title":"Delete a tag","openapi":"delete /collections/{collectionName}/tags/{tagName}","href":"/reference/api/endpoint/tag-delete"},{"title":"Create an alias","openapi":"post /collections/{collectionName}/aliases","href":"/reference/api/endpoint/alias-create"},{"title":"List aliases","openapi":"get /collections/{collectionName}/aliases","href":"/reference/api/endpoint/alias-list"},{"title":"Retarget an alias","openapi":"patch /collections/{collectionName}/aliases/{aliasName}","href":"/reference/api/endpoint/alias-retarget"},{"title":"Delete an alias","openapi":"delete /collections/{collectionName}/aliases/{aliasName}","href":"/reference/api/endpoint/alias-delete"}]},{"group":"Documents","pages":[{"title":"Upsert documents","openapi":"post /collections/{collectionName}/docs/upsert","href":"/reference/api/endpoint/document-upsert"},{"title":"Get bulk upsert URL","openapi":"get /collections/{collectionName}/docs/bulk-upsert","href":"/reference/api/endpoint/document-get-bulk-upsert-url"},{"title":"Bulk upsert documents","openapi":"post /collections/{collectionName}/docs/bulk-upsert","href":"/reference/api/endpoint/document-bulk-upsert"},{"title":"Update documents","openapi":"post /collections/{collectionName}/docs/update","href":"/reference/api/endpoint/document-update"},{"title":"Fetch documents","openapi":"post /collections/{collectionName}/docs/fetch","href":"/reference/api/endpoint/document-fetch"},{"title":"List documents","openapi":"get /collections/{collectionName}/docs","href":"/reference/api/endpoint/document-list"},{"title":"List documents extended","openapi":"post /collections/{collectionName}/docs/list","href":"/reference/api/endpoint/document-list-extended"},{"title":"Delete documents","openapi":"post /collections/{collectionName}/docs/delete","href":"/reference/api/endpoint/document-delete"}]},{"group":"Search","pages":[{"title":"Query a collection","openapi":"post /collections/{collectionName}/query","href":"/reference/api/endpoint/document-query"}]}]},{"group":"SDKs and tools","pages":[{"title":"Overview","href":"/reference/sdk/introduction"}]}]}]},"basePath":"","title":"Configure a collection - LambdaDB Documentation","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}