{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}
{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}
Attributes that can be used as filters and facets. Strings or objects with attributePatterns and features.
A rule declaring which attributes can be used for filtering and faceting.
A rule takes one of two forms. The object form lists attribute patterns
together with the filtering and faceting features they enable. The string
form names a single attribute and is a shorthand for an object matching that
attribute with the default features.
Chat (conversation) settings: index description, document template, and search parameters used when the LLM queries this index.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Meilisearch Documentation","colors":{"primary":"#FF5CB2","light":"#FF5CB2","dark":"#FF5CB2"},"logo":{"light":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-light.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=331f9ce2d1f557db3b679795f4707aa5","dark":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-dark.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=81634cdd715f6f159c69841b5d539d5a"},"favicon":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/favicon.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=33f47c7e13dd4d7005f570f6299328a5","api":{"playground":{"display":"simple"}},"appearance":{"default":"dark"},"background":{"decoration":"grid","color":{"light":"#F7F7F7","dark":"#1A003B"}},"navbar":{"links":[{"href":"https://www.meilisearch.com","label":"Website"},{"href":"https://github.com/meilisearch/meilisearch","label":"GitHub"},{"href":"https://discord.meilisearch.com/","label":"Discord"}],"primary":{"type":"button","label":"Start a trial","href":"https://cloud.meilisearch.com"}},"footer":{"socials":{"x":"https://x.com/meilisearch","github":"https://github.com/meilisearch","linkedin":"https://www.linkedin.com/company/meilisearch","website":"https://www.meilisearch.com"},"links":[{"header":"Product","items":[{"label":"Meilisearch Cloud","href":"https://www.meilisearch.com/cloud"},{"label":"AI search","href":"https://www.meilisearch.com/solutions/hybrid-search"},{"label":"Pricing","href":"https://www.meilisearch.com/pricing"},{"label":"Documentation","href":"https://www.meilisearch.com/docs"},{"label":"Roadmap","href":"https://roadmap.meilisearch.com"},{"label":"Release notes","href":"https://updates.cloud.meilisearch.com/"},{"label":"Comparisons","href":"https://www.meilisearch.com/docs/resources/comparisons/alternatives"},{"label":"Trust center","href":"https://trust.meilisearch.com/"}]},{"header":"Contact us","items":[{"label":"GitHub","href":"https://github.com/meilisearch"},{"label":"Discord","href":"https://discord.gg/meilisearch"},{"label":"Newsletter","href":"https://share-eu1.hsforms.com/1LN5N0x_GQgq7ss7tXmSykwfg3aq"},{"label":"Helpdesk","href":"https://help.meilisearch.com/"}]},{"header":"Company","items":[{"label":"Blog","href":"https://meilisearch.com/blog"},{"label":"Customers","href":"https://www.meilisearch.com/customers"},{"label":"Careers","href":"https://www.meilisearch.com/careers"},{"label":"Code of Conduct","href":"https://github.com/meilisearch/MeiliSearch/blob/main/CODE_OF_CONDUCT.md"},{"label":"Privacy Policy","href":"https://www.meilisearch.com/privacy-policy"},{"label":"Terms of Use","href":"https://www.meilisearch.com/terms-of-use"},{"label":"Swag","href":"https://swag.meilisearch.com/"}]}]},"seo":{"metatags":{"canonical":"https://www.meilisearch.com/docs"}},"integrations":{"fathom":{"siteId":"QNBPJXIV"},"gtm":{"tagId":"GTM-TNSCGVBH"},"posthog":{"apiKey":"phc_D5VtJkw6WyBzLtZ5tBvwR7ac4LvQZdFGYQTQfegRjh9n","apiHost":"https://t.meilisearch.com","sessionRecording":true},"segment":{"key":"KIC0Lcb5C9ssRY79dUKPOK8Wq6wLHiUP"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meilisearch-6b28dec2","hasAudioNarration":false,"actualSubdomain":"meilisearch-6b28dec2","customDomains":["www.meilisearch.com","meilisearch.dev"],"gitSource":{"type":"github","owner":"meilisearch","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1c4838e4709662983cc24","collectionId":"668baffb-e41e-4284-8a34-083961efc684","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1c4838e4709662983cc24"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4d82d6d11d33003dd1ea2","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Capabilities","count":168},{"language":"default","tag":"Reference","count":150},{"language":"default","tag":"API Routes","count":143},{"language":"default","tag":"Resources","count":89},{"language":"default","tag":"Settings","count":69},{"language":"default","tag":"How to","count":62},{"language":"default","tag":"Getting started","count":52},{"language":"default","tag":"Advanced","count":30},{"language":"default","tag":"Self-hosting","count":29},{"language":"default","tag":"Platform","count":27}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark\\:text-gray-400:is(.dark *){color:rgb(var(--gray-300))}#navigation-items h5{text-transform:uppercase}.callout h2,.callout h3,.callout h4,.callout h5,.callout h6{color:inherit}.noticeTag{color:rgb(var(--primary-light));border:1px solid rgb(var(--primary-light));padding:0 .5em;margin-left:.25em;display:inline-block;border-radius:5px;font-size:.8em}.routeHighlighter{--route-highlighter-color:rgba(100, 100, 100, 0.35);display:flex;border-radius:.375rem;border:1px var(--route-highlighter-color) solid;padding:1rem;gap:2rem;align-items:center;overflow:scroll}.routeHighlighter--GET{--route-highlighter-color:oklch(0.792 0.209 151.711)}.routeHighlighter--POST{--route-highlighter-color:oklch(0.623 0.214 259.815)}.routeHighlighter--DELETE{--route-highlighter-color:oklch(63.7% 0.237 25.331)}.routeHighlighter--PATCH,.routeHighlighter--PUT{--route-highlighter-color:oklch(0.828 0.189 84.429)}.routeHighlighter__method{font-weight:700;color:var(--route-highlighter-color)}.routeHighlighter__path{font-family:var(--font-jetbrains-mono),ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace}"},{"filePath":"meilisearch-search-bar.css","content":".meilisearch-bar-container{max-width:480px;width:100%;margin:0 auto;padding:0 10px}.meilisearch-search-bar{background-color:#fff;color:rgba(25,25,25,.7);border:1px solid rgba(255,255,255,.1);display:flex;align-items:center;border-radius:12px;padding:8px 16px;cursor:pointer;width:100%;transition:all .2s ease;backdrop-filter:blur(8px);font-size:14px}.dark .meilisearch-search-bar{background-color:rgba(25,17,53,.5);color:rgba(255,255,255,.7);border:1px solid rgba(255,255,255,.1)}.meilisearch-search-bar__text{flex-grow:1}.meilisearch-search-bar__shortcut{opacity:.7;font-size:12px}.meilisearch-flexwrapper{display:flex;justify-content:center;align-items:center;width:100%}.meilisearch-modal-overlay{position:fixed;top:0;left:0;width:100%;height:100%;backdrop-filter:blur(8px);background-color:rgba(0,0,0,.4);z-index:9999;display:none;align-items:flex-start;justify-content:center;padding-top:0;box-sizing:border-box}.meilisearch-modal{background-color:#fff;border:1px solid rgba(0,0,0,.5);width:600px;max-width:90%;max-height:80vh;margin-top:70px;border-radius:12px;box-shadow:0 8px 32px rgba(0,0,0,.3);display:flex;flex-direction:column;overflow:hidden}.dark .meilisearch-modal{background-color:#1a1033;border:1px solid rgba(255,255,255,.1)}.meilisearch-modal__input-container{display:flex;align-items:center;padding:16px 20px;border-bottom:1px solid rgba(0,0,0,.1)}.dark .meilisearch-modal__input-container{border-bottom:1px solid rgba(255,255,255,.1)}.meilisearch-modal__input{background:0 0;border:0;font-size:16px;outline:0;width:100%;margin-right:10px;color:rgb(var(--gray-700))}.dark .meilisearch-modal__input{color:rgb(var(--gray-100))}.meilisearch-modal__escape{font-size:12px;padding:4px 8px;border-radius:4px;margin-left:auto;background-color:rgba(0,0,0,.1)}.dark .meilisearch-modal__escape{color:rgba(255,255,255,.5);background-color:rgba(255,255,255,.1)}.meilisearch-modal__results{flex-grow:1;overflow-y:auto;padding:0}.meilisearch-modal__indicator{padding:20px;text-align:center}.dark .meilisearch-modal__indicator{color:rgba(255,255,255,.7)}.meilisearch-modal__result{display:block;padding:12px 20px;text-decoration:none;border-left:3px solid transparent;transition:background-color .2s,border-color .2s}.dark .meilisearch-modal__result{color:#fff}.meilisearch-modal__result:hover{background-color:rgba(0,0,0,.05);border-left-color:#f472b6}.dark .meilisearch-modal__result:hover{background-color:rgba(255,255,255,.05)}.meilisearch-modal__category-header{padding:12px 20px 8px;font-size:14px;font-weight:600;text-transform:uppercase;color:rgba(0,0,0,.45)}.dark .meilisearch-modal__category-header{color:rgba(255,255,255,.5)}.meilisearch-modal__result-heading{font-weight:500;margin-bottom:4px}.meilisearch-modal__result-content{font-size:13px;color:rgba(0,0,0,.45)}.dark .meilisearch-modal__result-content{color:rgba(255,255,255,.6)}.meilisearch-modal__category-em{font-style:normal;color:#f472b6;font-weight:700}.meilisearch-modal__error{padding:20px;text-align:center;color:#f87171}.meilisearch-filter-container{padding:16px 20px;border-bottom:1px solid rgba(0,0,0,.1);background-color:rgba(0,0,0,.02)}.dark .meilisearch-filter-container{border-bottom:1px solid rgba(255,255,255,.1);background-color:rgba(255,255,255,.02)}.meilisearch-filter-title{font-size:14px;font-weight:500;color:rgba(0,0,0,.7);margin-bottom:12px}.dark .meilisearch-filter-title{color:rgba(255,255,255,.7)}.meilisearch-filter-tags{display:flex;flex-wrap:wrap;gap:8px}.meilisearch-filter-tag{background-color:rgba(0,0,0,.05);border:1px solid rgba(0,0,0,.1);border-radius:6px;padding:6px 12px;font-size:13px;font-weight:500;color:rgba(0,0,0,.7);cursor:pointer;transition:all .2s ease;text-transform:capitalize}.dark .meilisearch-filter-tag{background-color:rgba(255,255,255,.05);border:1px solid rgba(255,255,255,.1);color:rgba(255,255,255,.7)}.meilisearch-filter-tag:hover{background-color:rgba(0,0,0,.1);border-color:rgba(0,0,0,.2)}.dark .meilisearch-filter-tag:hover{background-color:rgba(255,255,255,.1);border-color:rgba(255,255,255,.2)}.meilisearch-filter-tag.active{background-color:#f472b6;border-color:#f472b6;color:#fff}.meilisearch-filter-tag.active:hover{background-color:#cb4d86;border-color:#cb4d86}"}],"page":{"pagePath":"reference/api/settings/list-all-settings","slug":"/reference/api/settings/list-all-settings","pageMetadata":{"title":"List all settings","description":"Returns all settings of the index. Each setting is returned with its current value or the default if not set.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings","href":"/reference/api/settings/list-all-settings","autogeneratedByOpenApi":true},"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: \"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\"\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":"List all settings","description":"Returns all settings of the index. Each setting is returned with its current value or the default if not set.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings","href":"/reference/api/settings/list-all-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/meilisearch-6b28dec2/c598d5c5cb296702/search.js","/docs/_mintlify/custom/meilisearch-6b28dec2/92f00249b2342156/cookieyes-banner.js","/docs/_mintlify/custom/meilisearch-6b28dec2/7302b02a474aa050/fathom-data-attr.js","/docs/_mintlify/custom/meilisearch-6b28dec2/85493af1bed6e7fb/gtm.js"],"openApiReferenceData":{"operation":{"tags":["Settings"],"summary":"List all settings","description":"Returns all settings of the index. Each setting is returned with its current value or the default if not set.","operationId":"get_all","parameters":["863f4e20-9ceb-4510-847b-f61cd9478d3c"],"responses":{"200":"1b7a77c2-0ba4-4e87-b2c9-66077dcf9941","401":"d3ee7507-77ed-4bdc-bb32-d3e9febc7adf","404":"f3c9da95-016c-434c-a312-d1c5e86a78b1"},"security":["0bfc150e-d7f8-4513-9104-5565c24d9cfa"],"x-codeSamples":[{"lang":"cURL","source":"curl \\\n -X GET 'MEILISEARCH_URL/indexes/movies/settings' \\\n -H 'Authorization: Bearer API_KEY'"},{"lang":"JS","source":"client.index('movies').getSettings()"},{"lang":"PHP","source":"$client->index('movies')->getSettings();"},{"lang":"Python","source":"client.index('movies').get_settings()"},{"lang":"Java","source":"client.index(\"movies\").getSettings();"},{"lang":"Ruby","source":"client.index('movies').settings"},{"lang":"Go","source":"client.Index(\"movies\").GetSettings()"},{"lang":"C#","source":"await client.Index(\"movies\").GetSettingsAsync();"},{"lang":"Rust","source":"let settings: Settings = client\n .index(\"movies\")\n .get_settings()\n .await\n .unwrap();"},{"lang":"Dart","source":"await client.index('movies').getSettings();"},{"lang":"Swift","source":"client.index(\"movies\").getSettings { (result) in\n switch result {\n case .success(let setting):\n print(setting)\n case .failure(let error):\n print(error)\n }\n}"}],"method":"get","type":"path","servers":["bdde1061-cfb1-4636-a2c9-40d85a2fd614"],"path":"/indexes/{index_uid}/settings","baseUrlOptions":["http://localhost:7700"],"title":"List all settings","codeSamples":[{"lang":"cURL","source":"curl \\\n -X GET 'MEILISEARCH_URL/indexes/movies/settings' \\\n -H 'Authorization: Bearer API_KEY'"},{"lang":"JS","source":"client.index('movies').getSettings()"},{"lang":"PHP","source":"$client->index('movies')->getSettings();"},{"lang":"Python","source":"client.index('movies').get_settings()"},{"lang":"Java","source":"client.index(\"movies\").getSettings();"},{"lang":"Ruby","source":"client.index('movies').settings"},{"lang":"Go","source":"client.Index(\"movies\").GetSettings()"},{"lang":"C#","source":"await client.Index(\"movies\").GetSettingsAsync();"},{"lang":"Rust","source":"let settings: Settings = client\n .index(\"movies\")\n .get_settings()\n .await\n .unwrap();"},{"lang":"Dart","source":"await client.index('movies').getSettings();"},{"lang":"Swift","source":"client.index(\"movies\").getSettings { (result) in\n switch result {\n case .success(let setting):\n print(setting)\n case .failure(let error):\n print(error)\n }\n}"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"863f4e20-9ceb-4510-847b-f61cd9478d3c":{"name":"index_uid","in":"path","description":"Unique identifier of the index.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the index.","uniqueKey":"","typeLabel":"string"},"example":"movies"}},"responses":{"1b7a77c2-0ba4-4e87-b2c9-66077dcf9941":{"description":"Returns all settings with their current or default values. Same structure as the PATCH request body.","content":{"application/json":{"schema":{"type":"object","description":"Index settings: every option you can configure for search and index behavior.\n\nUsed as the request body for PATCH settings. Only the fields you send are updated; pass `null` to reset a setting to its default.\n\nSee also: [Configuring index settings on the Cloud](https://www.meilisearch.com/docs/learn/configuration/configuring_index_settings).","properties":{"displayedAttributes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"displayedAttributes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Fields returned in search results. Affects only search endpoints, not get-document endpoints. See [displayed and searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes).","example":["id","title","description","url"],"default":["*"],"uniqueKey":"displayedAttributes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Fields returned in search results. Affects only search endpoints, not get-document endpoints. See [displayed and searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes).","example":["id","title","description","url"],"default":["*"],"uniqueKey":"displayedAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"displayedAttributes","typeLabel":"string[] | null"},"searchableAttributes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"searchableAttributes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Fields searched for query words, in order of importance. Defines [attribute ranking order](https://www.meilisearch.com/docs/learn/relevancy/attribute_ranking_order). See [displayed and searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes).","example":["title","description"],"default":["*"],"uniqueKey":"searchableAttributes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Fields searched for query words, in order of importance. Defines [attribute ranking order](https://www.meilisearch.com/docs/learn/relevancy/attribute_ranking_order). See [displayed and searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes).","example":["title","description"],"default":["*"],"uniqueKey":"searchableAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"searchableAttributes","typeLabel":"string[] | null"},"filterableAttributes":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","description":"A rule declaring which attributes can be used for filtering and faceting.\n\nA rule takes one of two forms. The object form lists attribute patterns\ntogether with the filtering and faceting features they enable. The string\nform names a single attribute and is a shorthand for an object matching that\nattribute with the default features.","required":["attributePatterns"],"properties":{"attributePatterns":{"type":"array","items":{"type":"string","uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.attributePatterns.items.[INDEX]","typeLabel":"string"},"description":"Patterns to match attribute names. Use `*` as a wildcard to match any\ncharacters. For example, `[\"price_*\", \"stock\"]` matches `price_usd`,\n`price_eur`, and `stock`.","isRequired":true,"uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.attributePatterns","typeLabel":"string[]"},"features":{"type":"object","description":"The filtering and faceting features enabled for attributes matching\nthese patterns. If not specified, defaults to equality filtering\nenabled.","properties":{"facetSearch":{"type":"boolean","description":"When `true`, allows searching within facet values for matching\nattributes. This enables the facet search feature which lets users\nsearch for specific facet values. Defaults to `false`.","uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.features.facetSearch","typeLabel":"boolean"},"filter":{"type":"object","description":"Controls which filter operators are allowed for matching attributes.\nSee `FilterFeatures` for available options.","properties":{"equality":{"type":"boolean","description":"When `true`, enables equality operators: `=`, `!=`, and `IN`. These\nallow filtering for exact matches or membership in a set of values.\nAlso enables `IS EMPTY`, `IS NULL`, and `EXISTS` operators. Defaults\nto `true`.","uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.features.filter.equality","typeLabel":"boolean"},"comparison":{"type":"boolean","description":"When `true`, enables comparison operators: `\u003c`, `>`, `\u003c=`, `>=`, and\n`TO` (range). These allow filtering based on numeric or string\ncomparisons. Defaults to `false`.","uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.features.filter.comparison","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.features.filter","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0.features","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"string","description":"A rule declaring which attributes can be used for filtering and faceting.\n\nA rule takes one of two forms. The object form lists attribute patterns\ntogether with the filtering and faceting features they enable. The string\nform names a single attribute and is a shorthand for an object matching that\nattribute with the default features.","uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"filterableAttributes.oneOf.0.items.[INDEX]","typeLabel":"object | string"},"description":"Attributes that can be used as [filters](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results) and [facets](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters). Strings or objects with `attributePatterns` and `features`.","example":["genres","director",{"attributePatterns":["*_ratings"],"features":{"facetSearch":false,"filter":{"equality":true,"comparison":true}}}],"default":[],"uniqueKey":"filterableAttributes.oneOf.0","typeLabel":"(object | string)[]"},{"type":"null","items":{"oneOf":[{"type":"object","description":"A rule declaring which attributes can be used for filtering and faceting.\n\nA rule takes one of two forms. The object form lists attribute patterns\ntogether with the filtering and faceting features they enable. The string\nform names a single attribute and is a shorthand for an object matching that\nattribute with the default features.","required":["attributePatterns"],"properties":{"attributePatterns":{"type":"array","items":{"type":"string"},"description":"Patterns to match attribute names. Use `*` as a wildcard to match any\ncharacters. For example, `[\"price_*\", \"stock\"]` matches `price_usd`,\n`price_eur`, and `stock`."},"features":{"type":"object","description":"The filtering and faceting features enabled for attributes matching\nthese patterns. If not specified, defaults to equality filtering\nenabled.","properties":{"facetSearch":{"type":"boolean","description":"When `true`, allows searching within facet values for matching\nattributes. This enables the facet search feature which lets users\nsearch for specific facet values. Defaults to `false`."},"filter":{"type":"object","description":"Controls which filter operators are allowed for matching attributes.\nSee `FilterFeatures` for available options.","properties":{"equality":{"type":"boolean","description":"When `true`, enables equality operators: `=`, `!=`, and `IN`. These\nallow filtering for exact matches or membership in a set of values.\nAlso enables `IS EMPTY`, `IS NULL`, and `EXISTS` operators. Defaults\nto `true`."},"comparison":{"type":"boolean","description":"When `true`, enables comparison operators: `\u003c`, `>`, `\u003c=`, `>=`, and\n`TO` (range). These allow filtering based on numeric or string\ncomparisons. Defaults to `false`."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},{"type":"string","description":"A rule declaring which attributes can be used for filtering and faceting.\n\nA rule takes one of two forms. The object form lists attribute patterns\ntogether with the filtering and faceting features they enable. The string\nform names a single attribute and is a shorthand for an object matching that\nattribute with the default features."}]},"description":"Attributes that can be used as [filters](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results) and [facets](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters). Strings or objects with `attributePatterns` and `features`.","example":["genres","director",{"attributePatterns":["*_ratings"],"features":{"facetSearch":false,"filter":{"equality":true,"comparison":true}}}],"default":[],"uniqueKey":"filterableAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"filterableAttributes","typeLabel":"(object | string)[] | null"},"sortableAttributes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"sortableAttributes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results).","example":["release_date"],"default":[],"uniqueKey":"sortableAttributes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results).","example":["release_date"],"default":[],"uniqueKey":"sortableAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"sortableAttributes","typeLabel":"string[] | null"},"foreignKeys":{"oneOf":[{"type":"array","items":{"type":"object","required":["foreignIndexUid","fieldName"],"properties":{"foreignIndexUid":{"type":"string","isRequired":true,"uniqueKey":"foreignKeys.oneOf.0.items.[INDEX].foreignIndexUid","typeLabel":"string"},"fieldName":{"type":"string","isRequired":true,"uniqueKey":"foreignKeys.oneOf.0.items.[INDEX].fieldName","typeLabel":"string"}},"uniqueKey":"foreignKeys.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Foreign keys to use for cross-index filtering search.","example":[{"foreignIndexUid":"products","fieldName":"productId"}],"uniqueKey":"foreignKeys.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["foreignIndexUid","fieldName"],"properties":{"foreignIndexUid":{"type":"string"},"fieldName":{"type":"string"}}},"description":"Foreign keys to use for cross-index filtering search.","example":[{"foreignIndexUid":"products","fieldName":"productId"}],"uniqueKey":"foreignKeys.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignKeys","typeLabel":"object[] | null"},"rankingRules":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"rankingRules.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"[Ranking rules](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules) in order of importance. Built-in rules and custom sort rules (`attribute:asc` or `attribute:desc`).","example":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"default":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"uniqueKey":"rankingRules.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"[Ranking rules](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules) in order of importance. Built-in rules and custom sort rules (`attribute:asc` or `attribute:desc`).","example":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"default":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"uniqueKey":"rankingRules.oneOf.1","typeLabel":"null"}],"uniqueKey":"rankingRules","typeLabel":"string[] | null"},"stopWords":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"stopWords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Words ignored when present in search queries.","example":["the","a"],"default":[],"uniqueKey":"stopWords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Words ignored when present in search queries.","example":["the","a"],"default":[],"uniqueKey":"stopWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"stopWords","typeLabel":"string[] | null"},"nonSeparatorTokens":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"nonSeparatorTokens.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Characters that are not treated as word separators. Removed from the default separator set.","example":["@","#"],"default":[],"uniqueKey":"nonSeparatorTokens.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Characters that are not treated as word separators. Removed from the default separator set.","example":["@","#"],"default":[],"uniqueKey":"nonSeparatorTokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"nonSeparatorTokens","typeLabel":"string[] | null"},"separatorTokens":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"separatorTokens.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Characters that delimit words. Added on top of the default separators.","example":["|"],"default":[],"uniqueKey":"separatorTokens.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Characters that delimit words. Added on top of the default separators.","example":["|"],"default":[],"uniqueKey":"separatorTokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"separatorTokens","typeLabel":"string[] | null"},"dictionary":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"dictionary.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Strings Meilisearch parses as a single term. Useful for names or domain terms.","example":["J. R. R."],"default":[],"uniqueKey":"dictionary.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Strings Meilisearch parses as a single term. Useful for names or domain terms.","example":["J. R. R."],"default":[],"uniqueKey":"dictionary.oneOf.1","typeLabel":"null"}],"uniqueKey":"dictionary","typeLabel":"string[] | null"},"synonyms":{"oneOf":[{"type":"object","description":"Pairs of words or phrases treated as equivalent for search. Key maps to an array of [synonyms](https://www.meilisearch.com/docs/learn/relevancy/synonyms).","default":{},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"synonyms.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"synonyms.oneOf.0.additionalProperties","typeLabel":"string[]"},"propertyNames":{"type":"string"},"example":{"phone":["iPhone"]},"uniqueKey":"synonyms.oneOf.0","typeLabel":"object"},{"type":"null","description":"Pairs of words or phrases treated as equivalent for search. Key maps to an array of [synonyms](https://www.meilisearch.com/docs/learn/relevancy/synonyms).","default":{},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"synonyms.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"synonyms.oneOf.1.additionalProperties","typeLabel":"string[]"},"propertyNames":{"type":"string"},"example":{"phone":["iPhone"]},"uniqueKey":"synonyms.oneOf.1","typeLabel":"null"}],"uniqueKey":"synonyms","typeLabel":"object | null"},"distinctAttribute":{"oneOf":[{"type":"string","description":"Field whose value must be unique in the returned documents. One document per distinct value. See [distinct attribute](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute).","example":"sku","uniqueKey":"distinctAttribute.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field whose value must be unique in the returned documents. One document per distinct value. See [distinct attribute](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute).","example":"sku","uniqueKey":"distinctAttribute.oneOf.1","typeLabel":"null"}],"uniqueKey":"distinctAttribute","typeLabel":"string | null"},"proximityPrecision":{"oneOf":[{"type":"string","description":"Precision for the proximity ranking rule and phrase search: `byWord` (exact distance) or `byAttribute` (same attribute).","default":"byWord","example":"byWord","uniqueKey":"proximityPrecision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Precision for the proximity ranking rule and phrase search: `byWord` (exact distance) or `byAttribute` (same attribute).","default":"byWord","example":"byWord","uniqueKey":"proximityPrecision.oneOf.1","typeLabel":"null"}],"uniqueKey":"proximityPrecision","typeLabel":"string | null"},"typoTolerance":{"oneOf":[{"type":"null","default":{"enabled":true,"minWordSizeForTypos":{"oneTypo":5,"twoTypos":9},"disableOnWords":[],"disableOnAttributes":[],"disableOnNumbers":false},"uniqueKey":"typoTolerance.oneOf.0","typeLabel":"null"},{"type":"object","description":"[Typo tolerance](https://www.meilisearch.com/docs/learn/relevancy/typo_tolerance_settings): enable/disable, minimum word length for typos, and where to disable it.","default":{"enabled":true,"minWordSizeForTypos":{"oneTypo":5,"twoTypos":9},"disableOnWords":[],"disableOnAttributes":[],"disableOnNumbers":false},"properties":{"enabled":{"oneOf":[{"type":"boolean","description":"When true, typo tolerance is enabled. When false, only exact matches are returned.","default":true,"example":true,"uniqueKey":"typoTolerance.oneOf.1.enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, typo tolerance is enabled. When false, only exact matches are returned.","default":true,"example":true,"uniqueKey":"typoTolerance.oneOf.1.enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.enabled","typeLabel":"boolean | null"},"minWordSizeForTypos":{"oneOf":[{"type":"null","default":{"oneTypo":5,"twoTypos":9},"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.0","typeLabel":"null"},{"type":"object","description":"Minimum word length before typos are allowed. Contains `oneTypo` (min length for 1 typo) and `twoTypos` (min length for 2 typos). Example: `{ \"oneTypo\": 5, \"twoTypos\": 9 }`.","default":{"oneTypo":5,"twoTypos":9},"properties":{"oneTypo":{"oneOf":[{"type":"integer","format":"u-int8","description":"Minimum word length to accept one typo. Shorter words must match exactly. For example, if set to 5, \"apple\" can have one typo but \"app\" cannot.","default":5,"example":5,"minimum":0,"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.oneTypo.oneOf.0","typeLabel":"integer\u003cu-int8>"},{"type":"null","format":"u-int8","description":"Minimum word length to accept one typo. Shorter words must match exactly. For example, if set to 5, \"apple\" can have one typo but \"app\" cannot.","default":5,"example":5,"minimum":0,"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.oneTypo.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.oneTypo","typeLabel":"integer\u003cu-int8> | null"},"twoTypos":{"oneOf":[{"type":"integer","format":"u-int8","description":"Minimum word length to accept two typos. Must be greater than or equal to `oneTypo`. For example, if set to 9, \"computing\" can have two typos.","default":9,"example":9,"minimum":0,"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.twoTypos.oneOf.0","typeLabel":"integer\u003cu-int8>"},{"type":"null","format":"u-int8","description":"Minimum word length to accept two typos. Must be greater than or equal to `oneTypo`. For example, if set to 9, \"computing\" can have two typos.","default":9,"example":9,"minimum":0,"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.twoTypos.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1.twoTypos","typeLabel":"integer\u003cu-int8> | null"}},"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos.oneOf.1","typeLabel":"object"}],"uniqueKey":"typoTolerance.oneOf.1.minWordSizeForTypos","typeLabel":"null | object"},"disableOnWords":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"typoTolerance.oneOf.1.disableOnWords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly.","example":["iPhone","phone"],"default":[],"uniqueItems":true,"uniqueKey":"typoTolerance.oneOf.1.disableOnWords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly.","example":["iPhone","phone"],"default":[],"uniqueItems":true,"uniqueKey":"typoTolerance.oneOf.1.disableOnWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.disableOnWords","typeLabel":"string[] | null"},"disableOnAttributes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"typoTolerance.oneOf.1.disableOnAttributes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs.","example":["uuid","url"],"default":[],"uniqueItems":true,"uniqueKey":"typoTolerance.oneOf.1.disableOnAttributes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs.","example":["uuid","url"],"default":[],"uniqueItems":true,"uniqueKey":"typoTolerance.oneOf.1.disableOnAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.disableOnAttributes","typeLabel":"string[] | null"},"disableOnNumbers":{"oneOf":[{"type":"boolean","description":"When true, typo tolerance is disabled on numeric tokens. For example, 123 will not match 132.","default":false,"example":false,"uniqueKey":"typoTolerance.oneOf.1.disableOnNumbers.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, typo tolerance is disabled on numeric tokens. For example, 123 will not match 132.","default":false,"example":false,"uniqueKey":"typoTolerance.oneOf.1.disableOnNumbers.oneOf.1","typeLabel":"null"}],"uniqueKey":"typoTolerance.oneOf.1.disableOnNumbers","typeLabel":"boolean | null"}},"uniqueKey":"typoTolerance.oneOf.1","typeLabel":"object"}],"uniqueKey":"typoTolerance","typeLabel":"null | object"},"faceting":{"oneOf":[{"type":"null","default":{"maxValuesPerFacet":100,"sortFacetValuesBy":{"*":"alpha"}},"uniqueKey":"faceting.oneOf.0","typeLabel":"null"},{"type":"object","description":"Related to [faceting](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters): max facet values per facet and how facet values are sorted.","default":{"maxValuesPerFacet":100,"sortFacetValuesBy":{"*":"alpha"}},"properties":{"maxValuesPerFacet":{"oneOf":[{"type":"integer","description":"Maximum number of facet values returned per facet. Values are sorted in ascending lexicographical order.","default":100,"example":100,"minimum":0,"uniqueKey":"faceting.oneOf.1.maxValuesPerFacet.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of facet values returned per facet. Values are sorted in ascending lexicographical order.","default":100,"example":100,"minimum":0,"uniqueKey":"faceting.oneOf.1.maxValuesPerFacet.oneOf.1","typeLabel":"null"}],"uniqueKey":"faceting.oneOf.1.maxValuesPerFacet","typeLabel":"integer | null"},"sortFacetValuesBy":{"oneOf":[{"type":"object","description":"Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets.","default":{"*":"alpha"},"additionalProperties":{"type":"string","enum":["alpha","count","sampledCount"],"uniqueKey":"faceting.oneOf.1.sortFacetValuesBy.oneOf.0.additionalProperties","typeLabel":"enum\u003cstring>"},"propertyNames":{"type":"string"},"example":{"*":"alpha"},"uniqueKey":"faceting.oneOf.1.sortFacetValuesBy.oneOf.0","typeLabel":"object"},{"type":"null","description":"Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets.","default":{"*":"alpha"},"additionalProperties":{"type":"string","enum":["alpha","count","sampledCount"],"uniqueKey":"faceting.oneOf.1.sortFacetValuesBy.oneOf.1.additionalProperties","typeLabel":"enum\u003cstring>"},"propertyNames":{"type":"string"},"example":{"*":"alpha"},"uniqueKey":"faceting.oneOf.1.sortFacetValuesBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"faceting.oneOf.1.sortFacetValuesBy","typeLabel":"object | null"}},"uniqueKey":"faceting.oneOf.1","typeLabel":"object"}],"uniqueKey":"faceting","typeLabel":"null | object"},"pagination":{"oneOf":[{"type":"null","default":{"maxTotalHits":1000},"uniqueKey":"pagination.oneOf.0","typeLabel":"null"},{"type":"object","description":"Related to [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination): maximum number of results a search can return.","default":{"maxTotalHits":1000},"properties":{"maxTotalHits":{"oneOf":[{"type":"integer","description":"Maximum number of search results Meilisearch can return. Limit and offset cannot go beyond this value.","default":1000,"example":1000,"minimum":0,"uniqueKey":"pagination.oneOf.1.maxTotalHits.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of search results Meilisearch can return. Limit and offset cannot go beyond this value.","default":1000,"example":1000,"minimum":0,"uniqueKey":"pagination.oneOf.1.maxTotalHits.oneOf.1","typeLabel":"null"}],"uniqueKey":"pagination.oneOf.1.maxTotalHits","typeLabel":"integer | null"}},"uniqueKey":"pagination.oneOf.1","typeLabel":"object"}],"uniqueKey":"pagination","typeLabel":"null | object"},"embedders":{"oneOf":[{"type":"object","description":"[Embedders](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search) used for semantic and [hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search). Map of embedder name to config (`source`, `model`, `documentTemplate`, etc.).","default":{},"additionalProperties":{"type":"object","description":"Embedder configuration for [AI-powered / hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search).","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.0.additionalProperties.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `composite`: combine two embedding providers at indexing and search time.\n The generated embeddings must be **exactly the same** regardless of the embedding provider.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.0.additionalProperties.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.0.additionalProperties.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.0.additionalProperties.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.dimensions","typeLabel":"integer | null"},"binaryQuantized":{"oneOf":[{"type":"boolean","description":"When true, vectors are stored as 1-bit (smaller, faster, less precise).\n\n- Available for all sources.\n- Irreversible once enabled.\n- 🏗️ When set to true, embeddings are not regenerated, but they are binary quantized, which takes time.","uniqueKey":"embedders.oneOf.0.additionalProperties.binaryQuantized.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, vectors are stored as 1-bit (smaller, faster, less precise).\n\n- Available for all sources.\n- Irreversible once enabled.\n- 🏗️ When set to true, embeddings are not regenerated, but they are binary quantized, which takes time.","uniqueKey":"embedders.oneOf.0.additionalProperties.binaryQuantized.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.binaryQuantized","typeLabel":"boolean | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.0.additionalProperties.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.headers","typeLabel":"object | null"},"searchEmbedder":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.0","typeLabel":"null"},{"type":"object","description":"Embedder used at search time when using a composite embedder.\n\nSame sub-parameters as a top-level embedder (`source`, `model`, `url`, etc.); no `documentTemplate`/`documentTemplateMaxBytes`.","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.dimensions","typeLabel":"integer | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1.headers","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.searchEmbedder","typeLabel":"null | object"},"indexingEmbedder":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.0","typeLabel":"null"},{"type":"object","description":"Embedder used at indexing time when using a composite embedder.\n\nSame sub-parameters as a top-level embedder (`source`, `model`, `documentTemplate`, `url`, etc.).","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.dimensions","typeLabel":"integer | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1.headers","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.indexingEmbedder","typeLabel":"null | object"},"distribution":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.0.additionalProperties.distribution.oneOf.0","typeLabel":"null"},{"type":"object","description":"Affine transform (mean, sigma) applied to the semantic score to make it more comparable with the ranking score.\n\nSee also [this article](https://www.meilisearch.com/blog/fixing-hybrid-search#making-the-scores-comparable).\n\n- Available for all sources.\n- 🌱 Changing the value of this parameter never regenerates embeddings","required":["current_mean","current_sigma"],"properties":{"current_mean":{"type":"number","format":"float","description":"Value where the results are \"packed\".\n\nSimilarity scores are translated so that they are packed around 0.5 instead","isRequired":true,"uniqueKey":"embedders.oneOf.0.additionalProperties.distribution.oneOf.1.current_mean","typeLabel":"number\u003cfloat>"},"current_sigma":{"type":"number","format":"float","description":"standard deviation of a similarity score.\n\nSet below 0.4 to make the results less packed around the mean, and above 0.4 to make them more packed.","isRequired":true,"uniqueKey":"embedders.oneOf.0.additionalProperties.distribution.oneOf.1.current_sigma","typeLabel":"number\u003cfloat>"}},"uniqueKey":"embedders.oneOf.0.additionalProperties.distribution.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.0.additionalProperties.distribution","typeLabel":"null | object"}},"uniqueKey":"embedders.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"example":{"default":{"source":"openAi","model":"text-embedding-3-small","documentTemplate":"{{doc.title}}: {{doc.overview}}"}},"uniqueKey":"embedders.oneOf.0","typeLabel":"object"},{"type":"null","description":"[Embedders](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search) used for semantic and [hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search). Map of embedder name to config (`source`, `model`, `documentTemplate`, etc.).","default":{},"additionalProperties":{"type":"object","description":"Embedder configuration for [AI-powered / hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search).","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.1.additionalProperties.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `composite`: combine two embedding providers at indexing and search time.\n The generated embeddings must be **exactly the same** regardless of the embedding provider.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.1.additionalProperties.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.1.additionalProperties.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.1.additionalProperties.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.dimensions","typeLabel":"integer | null"},"binaryQuantized":{"oneOf":[{"type":"boolean","description":"When true, vectors are stored as 1-bit (smaller, faster, less precise).\n\n- Available for all sources.\n- Irreversible once enabled.\n- 🏗️ When set to true, embeddings are not regenerated, but they are binary quantized, which takes time.","uniqueKey":"embedders.oneOf.1.additionalProperties.binaryQuantized.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, vectors are stored as 1-bit (smaller, faster, less precise).\n\n- Available for all sources.\n- Irreversible once enabled.\n- 🏗️ When set to true, embeddings are not regenerated, but they are binary quantized, which takes time.","uniqueKey":"embedders.oneOf.1.additionalProperties.binaryQuantized.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.binaryQuantized","typeLabel":"boolean | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.1.additionalProperties.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.headers","typeLabel":"object | null"},"searchEmbedder":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.0","typeLabel":"null"},{"type":"object","description":"Embedder used at search time when using a composite embedder.\n\nSame sub-parameters as a top-level embedder (`source`, `model`, `url`, etc.); no `documentTemplate`/`documentTemplateMaxBytes`.","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.dimensions","typeLabel":"integer | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1.headers","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.searchEmbedder","typeLabel":"null | object"},"indexingEmbedder":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.0","typeLabel":"null"},{"type":"object","description":"Embedder used at indexing time when using a composite embedder.\n\nSame sub-parameters as a top-level embedder (`source`, `model`, `documentTemplate`, `url`, etc.).","properties":{"source":{"oneOf":[{"type":"null","default":"openAi","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.source.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embedding provider.\n\n- `openAi`: integration with OpenAI. Use `rest` for OpenAI-like APIs.\n- `huggingFace`: download a model from [Hugging Face](https://huggingface.co/), then compute embeddings on the local CPU/GPU.\n- `ollama`: integration with [ollama](https://ollama.com/).\n- `rest`: configurable integration with a remote embedder via its REST API.\n- `userProvided`: manually provide embeddings in documents.\n\n- Determines which other fields are required or allowed.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","default":"openAi","enum":["openAi","huggingFace","ollama","userProvided","rest","composite"],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.source.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.source","typeLabel":"null | enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model name.\n\n- Available for `openAi`, `huggingFace`, `ollama`.\n- Mandatory for `ollama`.\n- For `openAi`/`huggingFace` optional with defaults.\n- 🏗️ Changing the value of this parameter always regenerates embeddings.","example":"text-embedding-3-small","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.model","typeLabel":"string | null"},"revision":{"oneOf":[{"type":"string","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.revision.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model revision (e.g. Hugging Face commit SHA).\n\n- Only available for `huggingFace`.\n- If unset, latest is used.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","example":"617ca489d9e86b49b8167676d8220688b99db36e","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.revision.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.revision","typeLabel":"string | null"},"pooling":{"oneOf":[{"type":"null","default":"useModel","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.pooling.oneOf.0","typeLabel":"null"},{"type":"string","description":"Pooling method when computing embedding locally.\n\n- Only available for `huggingFace`.\n- `useModel`: automatically determine the pooling method depending on the chosen model (recommended).\n- `forceMean`: always use mean pooling.\n- `forceCls`: always use CLS pooling.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","default":"useModel","enum":["useModel","forceCls","forceMean"],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.pooling.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.pooling","typeLabel":"null | enum\u003cstring>"},"apiKey":{"oneOf":[{"type":"string","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.apiKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"API key sent to the embedder.\n\n- If not set for source `openAi`, the key is read from the `OPENAI_API_KEY` then `MEILI_OPENAI_API_KEY` environment variables.\n- If not set for other sources, no bearer token is sent.\n- This setting is partially hidden when returned by the settings\n- 🌱 Changing the value of this parameter never regenerates embeddings","example":"your-api-key","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.apiKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.apiKey","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"integer","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.dimensions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of dimensions of the embedding vectors.\n\n- Available for `userProvided`, `openAi`, `ollama`, `rest`.\n- Mandatory for `userProvided`.\n- For `openAi`/`ollama`/`rest` inferred if omitted.\n- 🏗️ For `openAi`, changing the value of this parameter always regenerates embeddings\n- 🌱 For other sources, changing the value of this parameter never regenerates embeddings","example":1536,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.dimensions","typeLabel":"integer | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Liquid template](https://shopify.github.io/liquid/) to build the text sent to the embedder for each document.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When modified, embeddings are regenerated for documents whose rendering through the template produces a different text.","example":"{{doc.title}}: {{doc.overview}}","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Max size in bytes of the rendered document template.\n\nLonger output is truncated.\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- Available for `openAi`, `huggingFace`, `ollama`, `rest`.\n- 🏗️ When increased, embeddings are regenerated for documents whose rendering through the template produces a different text.\n- 🌱 When decreased, embeddings are never regenerated","default":400,"example":400,"minimum":0,"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.documentTemplateMaxBytes","typeLabel":"integer | null"},"url":{"oneOf":[{"type":"string","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).","example":"http://localhost:11434/api/embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.url","typeLabel":"string | null"},"indexingFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at indexing time.\n\nFor `rest` with multimodal; key is fragment name, value the payload.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- Only available for `indexingEmbedder`, not `searchEmbedder`.\n- 🏗️ When a fragment is deleted by passing `null` to its name, the corresponding embeddings are removed from documents.\n- 🏗️ When a fragment is modified, the corresponding embeddings are regenerated if their rendered version changes.","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.indexingFragments","typeLabel":"object | null"},"searchFragments":{"oneOf":[{"type":"object","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Fragments (with [Liquid](https://shopify.github.io/liquid/)) sent to the embedder at search time.\n\nFor `rest` with multimodal.\n\nSee also [Image search with multimodal embeddings](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings)\n\n- 🌱 Changing the value of this parameter never regenerates embeddings","default":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.searchFragments.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.searchFragments","typeLabel":"object | null"},"request":{"description":"Request body template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{text}}\"` for the input.\n- Mandatory for `rest`.\n- 🏗️ Changing the value of this parameter always regenerates embeddings","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.request","typeLabel":"any"},"response":{"description":"Response template for `rest` embedder.\n\nSee also [Configure a REST embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/configure_rest_embedder)\n\n- Use `\"{{embedding}}\"` where the embedding array is.\n- Mandatory for `rest`.","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.response","typeLabel":"any"},"headers":{"oneOf":[{"type":"object","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.0.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings","additionalProperties":{"type":"string","uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.1.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1.headers","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.indexingEmbedder","typeLabel":"null | object"},"distribution":{"oneOf":[{"type":"null","uniqueKey":"embedders.oneOf.1.additionalProperties.distribution.oneOf.0","typeLabel":"null"},{"type":"object","description":"Affine transform (mean, sigma) applied to the semantic score to make it more comparable with the ranking score.\n\nSee also [this article](https://www.meilisearch.com/blog/fixing-hybrid-search#making-the-scores-comparable).\n\n- Available for all sources.\n- 🌱 Changing the value of this parameter never regenerates embeddings","required":["current_mean","current_sigma"],"properties":{"current_mean":{"type":"number","format":"float","description":"Value where the results are \"packed\".\n\nSimilarity scores are translated so that they are packed around 0.5 instead","uniqueKey":"embedders.oneOf.1.additionalProperties.distribution.oneOf.1.current_mean","typeLabel":"number\u003cfloat>"},"current_sigma":{"type":"number","format":"float","description":"standard deviation of a similarity score.\n\nSet below 0.4 to make the results less packed around the mean, and above 0.4 to make them more packed.","uniqueKey":"embedders.oneOf.1.additionalProperties.distribution.oneOf.1.current_sigma","typeLabel":"number\u003cfloat>"}},"uniqueKey":"embedders.oneOf.1.additionalProperties.distribution.oneOf.1","typeLabel":"object"}],"uniqueKey":"embedders.oneOf.1.additionalProperties.distribution","typeLabel":"null | object"}},"uniqueKey":"embedders.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"example":{"default":{"source":"openAi","model":"text-embedding-3-small","documentTemplate":"{{doc.title}}: {{doc.overview}}"}},"uniqueKey":"embedders.oneOf.1","typeLabel":"null"}],"uniqueKey":"embedders","typeLabel":"object | null"},"searchCutoffMs":{"oneOf":[{"type":"integer","format":"u-int64","description":"Maximum duration of a search in milliseconds. If reached, the search stops and returns results computed so far. When null, 1500 ms is used.","example":1500,"minimum":0,"uniqueKey":"searchCutoffMs.oneOf.0","typeLabel":"integer\u003cu-int64>"},{"type":"null","format":"u-int64","description":"Maximum duration of a search in milliseconds. If reached, the search stops and returns results computed so far. When null, 1500 ms is used.","example":1500,"minimum":0,"uniqueKey":"searchCutoffMs.oneOf.1","typeLabel":"null"}],"uniqueKey":"searchCutoffMs","typeLabel":"integer\u003cu-int64> | null"},"localizedAttributes":{"oneOf":[{"type":"array","items":{"type":"object","description":"Defines a rule for associating specific locales (languages) with\nattributes. This allows Meilisearch to use language-specific tokenization\nand processing for matched attributes, improving search quality for\nmultilingual content.","required":["attributePatterns","locales"],"properties":{"attributePatterns":{"type":"array","items":{"type":"string","uniqueKey":"localizedAttributes.oneOf.0.items.[INDEX].attributePatterns.items.[INDEX]","typeLabel":"string"},"description":"Patterns to match attribute names. Use `*` as a wildcard to match any\ncharacters. For example, `[\"title_*\", \"description\"]` matches\n`title_en`, `title_fr`, and `description`.","example":["*_ja"],"isRequired":true,"uniqueKey":"localizedAttributes.oneOf.0.items.[INDEX].attributePatterns","typeLabel":"string[]"},"locales":{"type":"array","items":{"type":"string","enum":["af","ak","am","ar","az","be","bn","bg","ca","cs","da","de","cy","el","en","eo","et","fi","fr","gu","he","hi","hr","hu","hy","id","it","jv","ja","kn","ka","km","ko","la","lv","lt","ml","mr","mk","my","ne","nl","nb","or","pa","fa","pl","pt","ro","ru","si","sk","sl","sn","es","sr","sv","ta","te","tl","th","tk","tr","uk","ur","uz","vi","yi","zh","zu","afr","aka","amh","ara","aze","bel","ben","bul","cat","ces","dan","deu","cym","ell","eng","epo","est","fin","fra","guj","heb","hin","hrv","hun","hye","ind","ita","jav","jpn","kan","kat","khm","kor","lat","lav","lit","mal","mar","mkd","mya","nep","nld","nob","ori","pan","pes","pol","por","ron","rus","sin","slk","slv","sna","spa","srp","swe","tam","tel","tgl","tha","tuk","tur","ukr","urd","uzb","vie","yid","zho","zul","cmn"],"uniqueKey":"localizedAttributes.oneOf.0.items.[INDEX].locales.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of locales (languages) to apply to matching attributes. When\nthese attributes are indexed, Meilisearch will use language-specific\ntokenization rules. Examples: `[\"en\", \"fr\"]` or `[\"jpn\", \"zho\"]`.","isRequired":true,"uniqueKey":"localizedAttributes.oneOf.0.items.[INDEX].locales","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"localizedAttributes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes.","example":[{"locales":["jpn"],"attributePatterns":["*_ja"]}],"default":[],"uniqueKey":"localizedAttributes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Defines a rule for associating specific locales (languages) with\nattributes. This allows Meilisearch to use language-specific tokenization\nand processing for matched attributes, improving search quality for\nmultilingual content.","required":["attributePatterns","locales"],"properties":{"attributePatterns":{"type":"array","items":{"type":"string"},"description":"Patterns to match attribute names. Use `*` as a wildcard to match any\ncharacters. For example, `[\"title_*\", \"description\"]` matches\n`title_en`, `title_fr`, and `description`.","example":["*_ja"]},"locales":{"type":"array","items":{"type":"string","enum":["af","ak","am","ar","az","be","bn","bg","ca","cs","da","de","cy","el","en","eo","et","fi","fr","gu","he","hi","hr","hu","hy","id","it","jv","ja","kn","ka","km","ko","la","lv","lt","ml","mr","mk","my","ne","nl","nb","or","pa","fa","pl","pt","ro","ru","si","sk","sl","sn","es","sr","sv","ta","te","tl","th","tk","tr","uk","ur","uz","vi","yi","zh","zu","afr","aka","amh","ara","aze","bel","ben","bul","cat","ces","dan","deu","cym","ell","eng","epo","est","fin","fra","guj","heb","hin","hrv","hun","hye","ind","ita","jav","jpn","kan","kat","khm","kor","lat","lav","lit","mal","mar","mkd","mya","nep","nld","nob","ori","pan","pes","pol","por","ron","rus","sin","slk","slv","sna","spa","srp","swe","tam","tel","tgl","tha","tuk","tur","ukr","urd","uzb","vie","yid","zho","zul","cmn"]},"description":"The list of locales (languages) to apply to matching attributes. When\nthese attributes are indexed, Meilisearch will use language-specific\ntokenization rules. Examples: `[\"en\", \"fr\"]` or `[\"jpn\", \"zho\"]`."}}},"description":"Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes.","example":[{"locales":["jpn"],"attributePatterns":["*_ja"]}],"default":[],"uniqueKey":"localizedAttributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"localizedAttributes","typeLabel":"object[] | null"},"facetSearch":{"oneOf":[{"type":"boolean","description":"When true, [facet search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters) is enabled. When false, the facet-search endpoint is disabled.","default":true,"example":true,"uniqueKey":"facetSearch.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, [facet search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters) is enabled. When false, the facet-search endpoint is disabled.","default":true,"example":true,"uniqueKey":"facetSearch.oneOf.1","typeLabel":"null"}],"uniqueKey":"facetSearch","typeLabel":"boolean | null"},"prefixSearch":{"oneOf":[{"type":"null","default":"indexingTime","uniqueKey":"prefixSearch.oneOf.0","typeLabel":"null"},{"type":"string","description":"When to compute prefix matches: `indexingTime` or `disabled`. `disabled` speeds up indexing but reduces relevancy.","default":"indexingTime","enum":["indexingTime","disabled"],"uniqueKey":"prefixSearch.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"prefixSearch","typeLabel":"null | enum\u003cstring>"},"chat":{"oneOf":[{"type":"null","default":{},"uniqueKey":"chat.oneOf.0","typeLabel":"null"},{"type":"object","description":"[Chat (conversation)](https://www.meilisearch.com/docs/learn/chat/getting_started_with_chat) settings: index description, document template, and search parameters used when the LLM queries this index.","default":{},"properties":{"description":{"oneOf":[{"type":"string","description":"Index description shown to the LLM so it can decide when and how to query this index.","default":"","example":"A comprehensive movie database containing titles, overviews, genres, and release dates","uniqueKey":"chat.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Index description shown to the LLM so it can decide when and how to query this index.","default":"","example":"A comprehensive movie database containing titles, overviews, genres, and release dates","uniqueKey":"chat.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.description","typeLabel":"string | null"},"documentTemplate":{"oneOf":[{"type":"string","description":"Liquid template that defines the text sent to the LLM for each document.","example":"{% for field in fields %}{% if field.is_searchable and field.value != nil %}{{ field.name }}: {{ field.value }}\n{% endif %}{% endfor %}","uniqueKey":"chat.oneOf.1.documentTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Liquid template that defines the text sent to the LLM for each document.","example":"{% for field in fields %}{% if field.is_searchable and field.value != nil %}{{ field.name }}: {{ field.value }}\n{% endif %}{% endfor %}","uniqueKey":"chat.oneOf.1.documentTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.documentTemplate","typeLabel":"string | null"},"documentTemplateMaxBytes":{"oneOf":[{"type":"integer","description":"Maximum size in bytes of the rendered document template. Longer text is truncated.","default":400,"example":400,"minimum":0,"uniqueKey":"chat.oneOf.1.documentTemplateMaxBytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum size in bytes of the rendered document template. Longer text is truncated.","default":400,"example":400,"minimum":0,"uniqueKey":"chat.oneOf.1.documentTemplateMaxBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.documentTemplateMaxBytes","typeLabel":"integer | null"},"searchParameters":{"oneOf":[{"type":"null","default":{},"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.0","typeLabel":"null"},{"type":"object","description":"Search parameters used when the LLM queries this index (`hybrid`, `limit`, `sort`, `distinct`, etc.).","default":{},"properties":{"hybrid":{"oneOf":[{"type":"null","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.hybrid.oneOf.0","typeLabel":"null"},{"type":"object","description":"Hybrid search: mix of keyword and semantic search. Requires an embedder (set via `embedder` and optionally `semanticRatio`).","required":["embedder"],"properties":{"embedder":{"type":"string","description":"Name of the embedder from the index embedders setting (`embedder` in JSON). Used to vectorize the query.","example":"default","isRequired":true,"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.hybrid.oneOf.1.embedder","typeLabel":"string"},"semanticRatio":{"type":"number","format":"float","description":"Balance between keyword (0.0) and semantic (1.0) search.","example":0.5,"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.hybrid.oneOf.1.semanticRatio","typeLabel":"number\u003cfloat>"}},"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.hybrid.oneOf.1","typeLabel":"object"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.hybrid","typeLabel":"null | object"},"limit":{"oneOf":[{"type":"integer","description":"Maximum number of documents returned per search performed by the LLM.","example":20,"minimum":0,"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of documents returned per search performed by the LLM.","example":20,"minimum":0,"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.limit","typeLabel":"integer | null"},"sort":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.sort.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Sort order: array of strings like `attribute:asc` or `attribute:desc`.","example":["price:asc","rating:desc"],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.sort.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Sort order: array of strings like `attribute:asc` or `attribute:desc`.","example":["price:asc","rating:desc"],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.sort.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.sort","typeLabel":"string[] | null"},"distinct":{"oneOf":[{"type":"string","description":"Attribute used to return at most one document per distinct value.","example":"sku","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.distinct.oneOf.0","typeLabel":"string"},{"type":"null","description":"Attribute used to return at most one document per distinct value.","example":"sku","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.distinct.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.distinct","typeLabel":"string | null"},"matchingStrategy":{"oneOf":[{"type":"null","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.matchingStrategy.oneOf.0","typeLabel":"null"},{"type":"string","description":"How query terms are matched: `last`, `all`, or `frequency`.","enum":["last","all","frequency"],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.matchingStrategy.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.matchingStrategy","typeLabel":"null | enum\u003cstring>"},"attributesToSearchOn":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.attributesToSearchOn.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Attributes on which to run the search. If unset, all searchable attributes are used.","example":["title","description"],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.attributesToSearchOn.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Attributes on which to run the search. If unset, all searchable attributes are used.","example":["title","description"],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.attributesToSearchOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.attributesToSearchOn","typeLabel":"string[] | null"},"rankingScoreThreshold":{"oneOf":[{"type":"null","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.rankingScoreThreshold.oneOf.0","typeLabel":"null"},{"type":"number","description":"Minimum ranking score (0.0–1.0) for a document to be included. Lower scores are excluded.","format":"double","uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.rankingScoreThreshold.oneOf.1","typeLabel":"number\u003cdouble>"}],"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1.rankingScoreThreshold","typeLabel":"null | number\u003cdouble>"}},"uniqueKey":"chat.oneOf.1.searchParameters.oneOf.1","typeLabel":"object"}],"uniqueKey":"chat.oneOf.1.searchParameters","typeLabel":"null | object"}},"uniqueKey":"chat.oneOf.1","typeLabel":"object"}],"uniqueKey":"chat","typeLabel":"null | object"}},"uniqueKey":"","typeLabel":"object"},"example":{"displayedAttributes":["id","title","description","url"],"searchableAttributes":["title","description"],"filterableAttributes":["release_date","genre"],"sortableAttributes":["release_date"],"rankingRules":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"stopWords":["the","a"],"nonSeparatorTokens":["@","#"],"separatorTokens":["|"],"dictionary":["J. R. R."],"synonyms":{"phone":["iPhone"]},"distinctAttribute":null,"typoTolerance":{"enabled":true,"minWordSizeForTypos":{"oneTypo":5,"twoTypos":9},"disableOnWords":[],"disableOnAttributes":["title"],"disableOnNumbers":false},"faceting":{"maxValuesPerFacet":100,"sortFacetValuesBy":{"genre":"count"}},"pagination":{"maxTotalHits":1000},"proximityPrecision":"byWord","embedders":{"default":{"source":"openAi","model":"text-embedding-3-small","documentTemplate":"{{doc.title}}: {{doc.overview}}"}},"searchCutoffMs":null,"localizedAttributes":[{"locales":["jpn"],"attributePatterns":["*_ja"]}],"facetSearch":true,"prefixSearch":"indexingTime","chat":{"description":"A comprehensive movie database","documentTemplateMaxBytes":400,"searchParameters":{"limit":20}}},"examples":{"Example":{"title":"Example","value":{"displayedAttributes":["id","title","description","url"],"searchableAttributes":["title","description"],"filterableAttributes":["release_date","genre"],"sortableAttributes":["release_date"],"rankingRules":["words","typo","proximity","attributeRank","sort","wordPosition","exactness"],"stopWords":["the","a"],"nonSeparatorTokens":["@","#"],"separatorTokens":["|"],"dictionary":["J. R. R."],"synonyms":{"phone":["iPhone"]},"distinctAttribute":null,"typoTolerance":{"enabled":true,"minWordSizeForTypos":{"oneTypo":5,"twoTypos":9},"disableOnWords":[],"disableOnAttributes":["title"],"disableOnNumbers":false},"faceting":{"maxValuesPerFacet":100,"sortFacetValuesBy":{"genre":"count"}},"pagination":{"maxTotalHits":1000},"proximityPrecision":"byWord","embedders":{"default":{"source":"openAi","model":"text-embedding-3-small","documentTemplate":"{{doc.title}}: {{doc.overview}}"}},"searchCutoffMs":null,"localizedAttributes":[{"locales":["jpn"],"attributePatterns":["*_ja"]}],"facetSearch":true,"prefixSearch":"indexingTime","chat":{"description":"A comprehensive movie database","documentTemplateMaxBytes":400,"searchParameters":{"limit":20}}}}},"exampleType":"examples"}},"exampleType":"examples"},"d3ee7507-77ed-4bdc-bb32-d3e9febc7adf":{"description":"The authorization header is missing.","content":{"application/json":{"schema":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","isRequired":true,"uniqueKey":"link","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The Authorization header is missing. It must use the bearer authorization method.","code":"missing_authorization_header","type":"auth","link":"https://docs.meilisearch.com/errors#missing_authorization_header"},"examples":{"Example":{"title":"Example","value":{"message":"The Authorization header is missing. It must use the bearer authorization method.","code":"missing_authorization_header","type":"auth","link":"https://docs.meilisearch.com/errors#missing_authorization_header"}}},"exampleType":"examples"}},"exampleType":"examples"},"f3c9da95-016c-434c-a312-d1c5e86a78b1":{"description":"Index not found.","content":{"application/json":{"schema":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","isRequired":true,"uniqueKey":"link","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Index `movies` not found.","code":"index_not_found","type":"invalid_request","link":"https://docs.meilisearch.com/errors#index_not_found"},"examples":{"Example":{"title":"Example","value":{"message":"Index `movies` not found.","code":"index_not_found","type":"invalid_request","link":"https://docs.meilisearch.com/errors#index_not_found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0bfc150e-d7f8-4513-9104-5565c24d9cfa":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"Uuidv4, string or JWT","description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","scopes":["settings.get","settings.*","*"],"schemeName":"Bearer"}}},"servers":{"bdde1061-cfb1-4636-a2c9-40d85a2fd614":{"url":"http://localhost:7700","description":"Local server."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Uuidv4, string or JWT","description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","scopes":["settings.get","settings.*","*"],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"assets/release-assets/meilisearch-openapi-mintlify.json"},"subdomain":"meilisearch-6b28dec2","siteName":"Meilisearch Documentation","title":"List all settings - Meilisearch Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T23:02:47.330Z","originalFileLocation":"reference/api/settings/list-all-settings.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=\"dark\"}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=\"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_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=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List all settings - Meilisearch Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meilisearch-6b28dec2.mintlify.app/_mintlify/api/og/v2?division=All+settings\u0026amp;title=List+all+settings\u0026amp;description=Returns+all+settings+of+the+index.+Each+setting+is+returned+with+its+current+value+or+the+default+if+not+set.\u0026amp;theme=25515a5016844863e4538b41\u0026amp;signature=0f5bfdb4f2d678d9d080d4764772f7c9ba5563e5cf9acb45c1ed3251bbe2fdf9\">\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=\"List all settings - Meilisearch Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meilisearch-6b28dec2.mintlify.app/_mintlify/api/og/v2?division=All+settings\u0026amp;title=List+all+settings\u0026amp;description=Returns+all+settings+of+the+index.+Each+setting+is+returned+with+its+current+value+or+the+default+if+not+set.\u0026amp;theme=25515a5016844863e4538b41\u0026amp;signature=0f5bfdb4f2d678d9d080d4764772f7c9ba5563e5cf9acb45c1ed3251bbe2fdf9\">\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=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5CB2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/api/settings/list-all-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.meilisearch.com/#organization\",\"name\":\"Meilisearch Documentation\",\"url\":\"https://www.meilisearch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-light.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=331f9ce2d1f557db3b679795f4707aa5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.meilisearch.com/docs#website\",\"name\":\"Meilisearch Documentation\",\"url\":\"https://www.meilisearch.com/docs\",\"publisher\":{\"@id\":\"https://www.meilisearch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#webpage\",\"url\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings\",\"name\":\"List all settings\",\"description\":\"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\",\"dateModified\":\"2026-10-27T23:02:47.330Z\",\"isPartOf\":{\"@id\":\"https://www.meilisearch.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Routes\",\"item\":\"https://www.meilisearch.com/docs/reference/api/indexes/list-all-indexes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all settings\",\"item\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#apireference\",\"headline\":\"List all settings\",\"name\":\"List all settings\",\"description\":\"Returns all settings of the index. Each setting is returned with its current value or the default if not set.\",\"url\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings\",\"mainEntityOfPage\":{\"@id\":\"https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#webpage\"},\"dateModified\":\"2026-10-27T23:02:47.330Z\",\"publisher\":{\"@id\":\"https://www.meilisearch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.meilisearch.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Meilisearch Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Meilisearch Documentation","nav":{"global":null,"tabs":[{"tab":"Getting started","pages":[{"title":"Getting started","href":"/getting_started/overview"}]},{"tab":"Capabilities","pages":[{"title":"Capabilities","href":"/capabilities/overview"}]},{"tab":"Reference","groups":[{"group":"Overview","pages":[{"title":"Authorization","sidebarTitle":"Authorization","href":"/reference/api/authorization"},{"title":"Headers","sidebarTitle":"Headers","href":"/reference/api/headers"},{"title":"Requests","sidebarTitle":"Requests","href":"/reference/api/requests"},{"title":"Pagination","sidebarTitle":"Pagination","href":"/reference/api/pagination"},{"title":"OpenAPI specifications","sidebarTitle":"OpenAPI specifications","href":"/reference/api/openapi"}]},{"group":"API Routes","pages":[{"group":"Indexes","pages":[{"title":"List all indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes","href":"/reference/api/indexes/list-all-indexes"},{"title":"Create index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes","href":"/reference/api/indexes/create-index"},{"title":"Get index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}","href":"/reference/api/indexes/get-index"},{"title":"Update index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}","href":"/reference/api/indexes/update-index"},{"title":"Delete index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}","href":"/reference/api/indexes/delete-index"},{"title":"Swap indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /swap-indexes","href":"/reference/api/indexes/swap-indexes"},{"title":"List index fields","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/fields","href":"/reference/api/indexes/list-index-fields"}]},{"group":"Documents","pages":[{"title":"List documents with GET","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/documents","href":"/reference/api/documents/list-documents-with-get"},{"title":"List documents with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/fetch","href":"/reference/api/documents/list-documents-with-post"},{"title":"Get document","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/documents/{document_id}","href":"/reference/api/documents/get-document"},{"title":"Add or replace documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents","href":"/reference/api/documents/add-or-replace-documents"},{"title":"Add or update documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/documents","href":"/reference/api/documents/add-or-update-documents"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/documents/{document_id}","href":"/reference/api/documents/delete-document"},{"title":"Delete all documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/documents","href":"/reference/api/documents/delete-all-documents"},{"title":"Delete documents by filter","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/delete","href":"/reference/api/documents/delete-documents-by-filter"},{"title":"Delete documents by batch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/delete-batch","href":"/reference/api/documents/delete-documents-by-batch"},{"title":"Edit documents by function","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/edit","href":"/reference/api/documents/edit-documents-by-function"}]},{"group":"Search","pages":[{"title":"Search with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/search","href":"/reference/api/search/search-with-post"},{"title":"Search with GET","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/search","href":"/reference/api/search/search-with-get"}]},{"group":"Multi-search","pages":[{"title":"Perform a multi-search","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /multi-search","href":"/reference/api/multi-search/perform-a-multi-search"}]},{"group":"Facet search","pages":[{"title":"Search for facet values","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/facet-search","href":"/reference/api/facet-search/search-for-facet-values"}]},{"group":"Similar documents","pages":[{"title":"Get similar documents with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/similar","href":"/reference/api/similar-documents/get-similar-documents-with-post"},{"title":"Get similar documents with GET","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/similar","href":"/reference/api/similar-documents/get-similar-documents-with-get"}]},{"group":"MCP","pages":[{"title":"Model context protocol (MCP)","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /mcp","href":"/reference/api/mcp/model-context-protocol-mcp"}]},{"group":"Chats","pages":[{"title":"List chat workspaces","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats","href":"/reference/api/chats/list-chat-workspaces"},{"title":"Get a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats/{workspace_uid}","href":"/reference/api/chats/get-a-chat-workspace"},{"title":"Delete a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /chats/{workspace_uid}","href":"/reference/api/chats/delete-a-chat-workspace"},{"title":"Request a chat completion","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /chats/{workspace_uid}/chat/completions","href":"/reference/api/chats/request-a-chat-completion"},{"title":"Get settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats/{workspace_uid}/settings","href":"/reference/api/chats/get-settings-of-a-chat-workspace"},{"title":"Update settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /chats/{workspace_uid}/settings","href":"/reference/api/chats/update-settings-of-a-chat-workspace"},{"title":"Reset the settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /chats/{workspace_uid}/settings","href":"/reference/api/chats/reset-the-settings-of-a-chat-workspace"}]},{"group":"Search Rules","pages":[{"title":"List search rules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /dynamic-search-rules","href":"/reference/api/search-rules/list-search-rules"},{"title":"Delete all search rules.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /dynamic-search-rules","href":"/reference/api/search-rules/delete-all-search-rules"},{"title":"Get a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/get-a-search-rule"},{"title":"Create or update a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/create-or-update-a-search-rule"},{"title":"Delete a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/delete-a-search-rule"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks","href":"/reference/api/async-task-management/list-tasks"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/{task_id}","href":"/reference/api/async-task-management/get-task"},{"title":"Get task's document payload","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/{task_id}/documents","href":"/reference/api/async-task-management/get-tasks-document-payload"},{"title":"Cancel tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /tasks/cancel","href":"/reference/api/async-task-management/cancel-tasks"},{"title":"Delete tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /tasks","href":"/reference/api/async-task-management/delete-tasks"},{"title":"Stream tasks changes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/stream","href":"/reference/api/async-task-management/stream-tasks-changes"}]},{"group":"Batches","pages":[{"title":"List batches","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches","href":"/reference/api/async-task-management/list-batches"},{"title":"Get batch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches/{batch_id}","href":"/reference/api/async-task-management/get-batch"},{"title":"Stream batches changes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches/stream","href":"/reference/api/async-task-management/stream-batches-changes"}]},{"group":"Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /keys","href":"/reference/api/keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /keys","href":"/reference/api/keys/create-api-key"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /keys/{key}","href":"/reference/api/keys/get-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /keys/{key}","href":"/reference/api/keys/update-api-key"},{"title":"Delete API key","description":"Permanently delete the specified API key. The key will no longer be valid for authentication.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /keys/{key}","href":"/reference/api/keys/delete-api-key"}]},{"group":"Settings","pages":[{"group":"All settings","pages":[{"title":"List all settings","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings","href":"/reference/api/settings/list-all-settings"},{"title":"Update all settings","description":"Updates one or more settings for the index. Only the fields sent in the body are changed. Pass null for a setting to reset it to its default. If the index does not exist, it is created.\n\nSee also: [Configuring index settings on the Cloud](https://www.meilisearch.com/docs/learn/configuration/configuring_index_settings).","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings","href":"/reference/api/settings/update-all-settings"},{"title":"Reset all settings","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings","href":"/reference/api/settings/reset-all-settings"}]},{"group":"Chat","pages":[{"title":"Get chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/get-chat"},{"title":"Update chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/update-chat"},{"title":"Reset chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/reset-chat"}]},{"group":"Dictionary","pages":[{"title":"Get dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/get-dictionary"},{"title":"Update dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/update-dictionary"},{"title":"Reset dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/reset-dictionary"}]},{"group":"Displayed attributes","pages":[{"title":"Get displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/get-displayedattributes"},{"title":"Update displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/update-displayedattributes"},{"title":"Reset displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/reset-displayedattributes"}]},{"group":"Distinct attribute","pages":[{"title":"Get distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/get-distinctattribute"},{"title":"Update distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/update-distinctattribute"},{"title":"Reset distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/reset-distinctattribute"}]},{"group":"Embedders","pages":[{"title":"Get embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/get-embedders"},{"title":"Update embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/update-embedders"},{"title":"Reset embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/reset-embedders"}]},{"group":"Facet search","pages":[{"title":"Get facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/get-facetsearch"},{"title":"Update facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/update-facetsearch"},{"title":"Reset facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/reset-facetsearch"}]},{"group":"Faceting","pages":[{"title":"Get faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/get-faceting"},{"title":"Update faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/update-faceting"},{"title":"Reset faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/reset-faceting"}]},{"group":"Filterable attributes","pages":[{"title":"Get filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/get-filterableattributes"},{"title":"Update filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/update-filterableattributes"},{"title":"Reset filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/reset-filterableattributes"}]},{"group":"Foreign keys","pages":[{"title":"Get foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/get-foreignkeys"},{"title":"Update foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/update-foreignkeys"},{"title":"Reset foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/reset-foreignkeys"}]},{"group":"Localized attributes","pages":[{"title":"Get localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/get-localizedattributes"},{"title":"Update localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/update-localizedattributes"},{"title":"Reset localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/reset-localizedattributes"}]},{"group":"Non-separator tokens","pages":[{"title":"Get nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/get-nonseparatortokens"},{"title":"Update nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/update-nonseparatortokens"},{"title":"Reset nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/reset-nonseparatortokens"}]},{"group":"Pagination","pages":[{"title":"Get pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/get-pagination"},{"title":"Update pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/update-pagination"},{"title":"Reset pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/reset-pagination"}]},{"group":"Prefix search","pages":[{"title":"Get prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/get-prefixsearch"},{"title":"Update prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/update-prefixsearch"},{"title":"Reset prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/reset-prefixsearch"}]},{"group":"Proximity precision","pages":[{"title":"Get proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/get-proximityprecision"},{"title":"Update proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/update-proximityprecision"},{"title":"Reset proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/reset-proximityprecision"}]},{"group":"Ranking rules","pages":[{"title":"Get rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/get-rankingrules"},{"title":"Update rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/update-rankingrules"},{"title":"Reset rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/reset-rankingrules"}]},{"group":"Search cutoff","pages":[{"title":"Get searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/get-searchcutoffms"},{"title":"Update searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/update-searchcutoffms"},{"title":"Reset searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/reset-searchcutoffms"}]},{"group":"Searchable attributes","pages":[{"title":"Get searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/get-searchableattributes"},{"title":"Update searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/update-searchableattributes"},{"title":"Reset searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/reset-searchableattributes"}]},{"group":"Separator tokens","pages":[{"title":"Get separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/get-separatortokens"},{"title":"Update separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/update-separatortokens"},{"title":"Reset separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/reset-separatortokens"}]},{"group":"Sortable attributes","pages":[{"title":"Get sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/get-sortableattributes"},{"title":"Update sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/update-sortableattributes"},{"title":"Reset sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/reset-sortableattributes"}]},{"group":"Stop words","pages":[{"title":"Get stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/get-stopwords"},{"title":"Update stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/update-stopwords"},{"title":"Reset stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/reset-stopwords"}]},{"group":"Synonyms","pages":[{"title":"Get synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/get-synonyms"},{"title":"Update synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/update-synonyms"},{"title":"Reset synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/reset-synonyms"}]},{"group":"Typo tolerance","pages":[{"title":"Get typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/get-typotolerance"},{"title":"Update typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/update-typotolerance"},{"title":"Reset typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/reset-typotolerance"}]}]},{"group":"Management","pages":[{"group":"Stats","pages":[{"title":"Get stats of index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/stats","href":"/reference/api/indexes/get-stats-of-index"},{"title":"Get stats of all indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /stats","href":"/reference/api/stats/get-stats-of-all-indexes"}]},{"group":"Health","pages":[{"title":"Get health","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /health","href":"/reference/api/health/get-health"}]},{"group":"Version","pages":[{"title":"Get version","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /version","href":"/reference/api/version/get-version"}]},{"group":"Template","pages":[{"title":"Render template","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /render-template","href":"/reference/api/render-templates/render-template"}]},{"group":"Snapshots","pages":[{"title":"Create snapshot","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /snapshots","href":"/reference/api/backups/create-snapshot"}]},{"group":"Dumps","pages":[{"title":"Create dump","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /dumps","href":"/reference/api/backups/create-dump"}]},{"group":"Logs","pages":[{"title":"Retrieve logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /logs/stream","href":"/reference/api/logs/retrieve-logs"},{"title":"Stop retrieving logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /logs/stream","href":"/reference/api/logs/stop-retrieving-logs"},{"title":"Update target of the console logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /logs/stderr","href":"/reference/api/logs/update-target-of-the-console-logs"}]},{"group":"Metrics","pages":[{"title":"Get Prometheus metrics","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /metrics","href":"/reference/api/stats/get-prometheus-metrics"}]},{"group":"Experimental features","pages":[{"title":"List experimental features","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /experimental-features","href":"/reference/api/experimental-features/list-experimental-features"},{"title":"Configure experimental features","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /experimental-features","href":"/reference/api/experimental-features/configure-experimental-features"}]},{"group":"Network","pages":[{"title":"Get network topology","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /network","href":"/reference/api/experimental-features/get-network-topology"},{"title":"Configure network topology","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /network","href":"/reference/api/experimental-features/configure-network-topology"},{"title":"Network control","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /network/control","href":"/reference/api/experimental-features/network-control"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /webhooks","href":"/reference/api/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /webhooks","href":"/reference/api/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /webhooks/{uuid}","href":"/reference/api/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /webhooks/{uuid}","href":"/reference/api/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /webhooks/{uuid}","href":"/reference/api/webhooks/delete-webhook"}]},{"group":"Compact","pages":[{"title":"Compact index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/compact","href":"/reference/api/indexes/compact-index"},{"title":"Compact task queue","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /tasks/compact","href":"/reference/api/async-task-management/compact-task-queue"}]},{"group":"Export","pages":[{"title":"Export to a remote Meilisearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /export","href":"/reference/api/export/export-to-a-remote-meilisearch"}]},{"group":"Render template","pages":[{"title":"Render template","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /render-template","href":"/reference/api/render-templates/render-template"}]}]}]},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Overview","href":"/reference/errors/overview"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/reference/errors/error_codes"}]}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/comparisons/alternatives"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"List all settings - Meilisearch Documentation","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}