diff --git a/.gitmodules b/.gitmodules
index b3e72e9d6..f94b812a8 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -128,3 +128,8 @@
url = https://github.com/distilled-mirror/spec-mirror-modal.git
ignore = dirty
shallow = true
+[submodule "packages/meilisearch/specs/spec-mirror-meilisearch"]
+ path = packages/meilisearch/specs/spec-mirror-meilisearch
+ url = https://github.com/distilled-mirror/spec-mirror-meilisearch.git
+ ignore = dirty
+ shallow = true
diff --git a/packages/meilisearch/.generated-specs/meilisearch.json b/packages/meilisearch/.generated-specs/meilisearch.json
new file mode 100644
index 000000000..7f098cdcd
--- /dev/null
+++ b/packages/meilisearch/.generated-specs/meilisearch.json
@@ -0,0 +1,19993 @@
+{
+ "smithy": "2.0",
+ "metadata": {
+ "suppressions": [
+ {
+ "id": "HttpUriConflict",
+ "namespace": "*"
+ },
+ {
+ "id": "HttpMethodSemantics",
+ "namespace": "*"
+ },
+ {
+ "id": "UnreferencedShape",
+ "namespace": "*"
+ }
+ ]
+ },
+ "shapes": {
+ "com.meilisearch.api#GetBatchesRequestBatchUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetBatchesRequestUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetBatchesRequestCanceledByList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetBatchesRequestTypesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#Status": {
+ "type": "enum",
+ "members": {
+ "ENQUEUED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "enqueued"
+ }
+ },
+ "PROCESSING": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "processing"
+ }
+ },
+ "SUCCEEDED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "succeeded"
+ }
+ },
+ "FAILED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "failed"
+ }
+ },
+ "CANCELED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "canceled"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The status of a task."
+ }
+ },
+ "com.meilisearch.api#GetBatchesRequestStatusesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Status"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetBatchesRequestIndexUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetBatchesRequest": {
+ "type": "structure",
+ "members": {
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of batches to return."
+ }
+ },
+ "from": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "from",
+ "smithy.api#documentation": "`uid` of the first batch returned."
+ }
+ },
+ "reverse": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "reverse",
+ "smithy.api#documentation": "If `true`, returns results in the reverse order, from oldest to most recent."
+ }
+ },
+ "batchUids": {
+ "target": "com.meilisearch.api#GetBatchesRequestBatchUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "batchUids",
+ "smithy.api#documentation": "Permits to filter tasks by their batch uid. By default, when the\n`batchUids` query parameter is not set, all task uids are returned.\nIt's possible to specify several batch uids by separating them with\nthe `,` character."
+ }
+ },
+ "uids": {
+ "target": "com.meilisearch.api#GetBatchesRequestUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "uids",
+ "smithy.api#documentation": "Permits to filter tasks by their uid. By default, when the uids query\nparameter is not set, all task uids are returned. It's possible to\nspecify several uids by separating them with the `,` character."
+ }
+ },
+ "canceledBy": {
+ "target": "com.meilisearch.api#GetBatchesRequestCanceledByList",
+ "traits": {
+ "smithy.api#httpQuery": "canceledBy",
+ "smithy.api#documentation": "Permits to filter tasks using the uid of the task that canceled them.\nIt's possible to specify several task uids by separating them with\nthe `,` character."
+ }
+ },
+ "types": {
+ "target": "com.meilisearch.api#GetBatchesRequestTypesList",
+ "traits": {
+ "smithy.api#httpQuery": "types",
+ "smithy.api#documentation": "Permits to filter tasks by their related type. By default, when `types`\nquery parameter is not set, all task types are returned. It's possible\nto specify several types by separating them with the `,` character."
+ }
+ },
+ "statuses": {
+ "target": "com.meilisearch.api#GetBatchesRequestStatusesList",
+ "traits": {
+ "smithy.api#httpQuery": "statuses",
+ "smithy.api#documentation": "Permits to filter tasks by their status. By default, when `statuses`\nquery parameter is not set, all task statuses are returned. It's\npossible to specify several statuses by separating them with the `,`\ncharacter."
+ }
+ },
+ "indexUids": {
+ "target": "com.meilisearch.api#GetBatchesRequestIndexUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "indexUids",
+ "smithy.api#documentation": "Permits to filter tasks by their related index. By default, when\n`indexUids` query parameter is not set, the tasks of all the indexes\nare returned. It is possible to specify several indexes by separating\nthem with the `,` character."
+ }
+ },
+ "afterEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished before the given date. Supports RFC 3339 date format."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#AllBatches": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#AllBatchesResultsList",
+ "traits": {
+ "smithy.api#documentation": "Array of batch objects",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of batches",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of batches returned",
+ "smithy.api#required": {}
+ }
+ },
+ "from": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The first batch uid returned",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "next": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Value to send in from to fetch the next slice of results",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Response containing a paginated list of batches"
+ }
+ },
+ "com.meilisearch.api#BatchView": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The unique sequential identifier assigned to this batch. Batch UIDs\nare assigned in order of creation and can be used to retrieve specific\nbatch information or correlate tasks that were processed together.",
+ "smithy.api#required": {}
+ }
+ },
+ "progress": {
+ "target": "com.meilisearch.api#ProgressView",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "details": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Aggregated details from all tasks in this batch. For example, if the\nbatch contains multiple document addition tasks, this will show the\ntotal number of documents received and indexed across all tasks.",
+ "smithy.api#required": {}
+ }
+ },
+ "stats": {
+ "target": "com.meilisearch.api#BatchStatsView",
+ "traits": {
+ "smithy.api#documentation": "Statistical information about the batch, including the number of tasks\nby status, the types of tasks included, and the indexes affected.\nUseful for understanding the composition and outcome of the batch.",
+ "smithy.api#required": {}
+ }
+ },
+ "duration": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The total time spent processing this batch, formatted as an ISO-8601\nduration (e.g., `PT2.5S` for 2.5 seconds). This is `null` for batches\nthat haven't finished processing yet.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "startedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The timestamp when Meilisearch began processing this batch, formatted\nas an RFC 3339 date-time string. All batches have a start time as it's\nset when processing begins."
+ }
+ },
+ "finishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The timestamp when this batch finished processing, formatted as an\nRFC 3339 date-time string. This is `null` for batches that are still\nbeing processed.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "batchStrategy": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Explains why the batch was finalized and stopped accepting more tasks.\nCommon reasons include reaching the maximum batch size, encountering\nincompatible tasks, or processing being explicitly triggered."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents a batch of tasks that were processed together."
+ }
+ },
+ "com.meilisearch.api#ProgressView": {
+ "type": "structure",
+ "members": {
+ "steps": {
+ "target": "com.meilisearch.api#ProgressViewStepsList",
+ "traits": {
+ "smithy.api#documentation": "A hierarchical list of processing steps currently being executed.\nSteps are listed from outermost to innermost, with each step\nrepresenting a more granular operation within its parent step.",
+ "smithy.api#required": {}
+ }
+ },
+ "percentage": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "The overall completion percentage of the operation (0.0 to 100.0).\nThis is calculated by combining the progress of all nested steps,\nweighted by their relative importance.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Real-time progress information for a batch or task that is currently\nbeing processed. Use this to display progress bars or status updates to\nusers."
+ }
+ },
+ "com.meilisearch.api#ProgressStepView": {
+ "type": "structure",
+ "members": {
+ "currentStep": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A human-readable name describing what this processing step is doing.\nExamples include \"indexing documents\", \"computing embeddings\",\n\"building word cache\", etc.",
+ "smithy.api#required": {}
+ }
+ },
+ "finished": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The number of items that have been processed so far in this step.\nCompare with `total` to calculate the percentage complete for this\nspecific step.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The total number of items to process in this step. When `finished`\nequals `total`, this step is complete and processing moves to the\nnext step.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Information about a single processing step within a batch or task. Each\nstep has a name, current progress, and total items to process."
+ }
+ },
+ "com.meilisearch.api#ProgressViewStepsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ProgressStepView"
+ },
+ "traits": {
+ "smithy.api#documentation": "A hierarchical list of processing steps currently being executed.\nSteps are listed from outermost to innermost, with each step\nrepresenting a more granular operation within its parent step."
+ }
+ },
+ "com.meilisearch.api#BatchStatsView": {
+ "type": "structure",
+ "members": {
+ "totalNbTasks": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of tasks in the batch",
+ "smithy.api#required": {}
+ }
+ },
+ "status": {
+ "target": "com.meilisearch.api#BatchStatsViewStatusMap",
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by status",
+ "smithy.api#required": {}
+ }
+ },
+ "types": {
+ "target": "com.meilisearch.api#BatchStatsViewTypesMap",
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by type",
+ "smithy.api#required": {}
+ }
+ },
+ "indexUids": {
+ "target": "com.meilisearch.api#BatchStatsViewIndexUidsMap",
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by index UID",
+ "smithy.api#required": {}
+ }
+ },
+ "progressTrace": {
+ "target": "com.meilisearch.api#BatchStatsViewProgressTraceMap",
+ "traits": {
+ "smithy.api#documentation": "Detailed progress trace information"
+ }
+ },
+ "writeChannelCongestion": {
+ "target": "com.meilisearch.api#BatchStatsViewWriteChannelCongestionMap",
+ "traits": {
+ "smithy.api#documentation": "Write channel congestion metrics",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "internalDatabaseSizes": {
+ "target": "com.meilisearch.api#BatchStatsViewInternalDatabaseSizesMap",
+ "traits": {
+ "smithy.api#documentation": "Internal database size information"
+ }
+ },
+ "embedderRequests": {
+ "target": "com.meilisearch.api#EmbedderStatsView",
+ "traits": {
+ "smithy.api#documentation": "Statistics about AI embedder API requests made during batch processing.\nIncludes total requests, successful/failed counts, and response times.\nOnly present when the batch involved vector embedding operations."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Provides comprehensive statistics about a batch's execution.\n\nIncludes task counts, status breakdowns, and AI embedder usage. This\ninformation is useful for monitoring system performance and understanding\nbatch composition."
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewStatusMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by status"
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewTypesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by type"
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewIndexUidsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of tasks by index UID"
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewProgressTraceMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Detailed progress trace information"
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewWriteChannelCongestionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Write channel congestion metrics"
+ }
+ },
+ "com.meilisearch.api#BatchStatsViewInternalDatabaseSizesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Internal database size information"
+ }
+ },
+ "com.meilisearch.api#EmbedderStatsView": {
+ "type": "structure",
+ "members": {
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of embedder requests",
+ "smithy.api#required": {}
+ }
+ },
+ "failed": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of failed embedder requests",
+ "smithy.api#required": {}
+ }
+ },
+ "lastError": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Last error message from the embedder",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Statistics for embedder requests"
+ }
+ },
+ "com.meilisearch.api#AllBatchesResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#BatchView"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of batch objects"
+ }
+ },
+ "com.meilisearch.api#GetBatches": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetBatchesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#AllBatches"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/batches",
+ "code": 200
+ },
+ "smithy.api#documentation": "List batches\n\nMeilisearch groups compatible tasks ([asynchronous operations](https://www.meilisearch.com/docs/learn/async/asynchronous_operations)) into batches for efficient processing.\n\nFor example, multiple document additions to the same index may be batched together. List batches to monitor their progress and performance.\n\nBatches are always returned in descending order of uid. This means that by default, the most recently created batch objects appear first. Batch results are paginated and can be filtered with query parameters."
+ }
+ },
+ "com.meilisearch.api#GetBatchesStream": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/batches/stream",
+ "code": 200
+ },
+ "smithy.api#documentation": "Stream batches changes\n\nThe `/batches/stream` route returns information about [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) (indexing, document updates, settings changes, and so on).\n\nBatches are sent throught an SSE stream any time their progress or status changes, i.e., enqueued, processing, succeeded, failed."
+ }
+ },
+ "com.meilisearch.api#GetBatchRequest": {
+ "type": "structure",
+ "members": {
+ "batch_id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique batch identifier."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetBatch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetBatchRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#BatchView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/batches/{batch_id}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get batch\n\nMeilisearch groups compatible tasks ([asynchronous operations](https://www.meilisearch.com/docs/learn/async/asynchronous_operations)) into batches for efficient processing.\n\nFor example, multiple document additions to the same index may be batched together. Retrieve a single batch by its unique identifier to monitor its progress and performance."
+ }
+ },
+ "com.meilisearch.api#ListWorkspaces": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/chats",
+ "code": 200
+ },
+ "smithy.api#documentation": "List chat workspaces\n\nList all chat workspaces registered on the instance, with pagination.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#GetChatRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetChat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetChatRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/chats/{workspace_uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get a chat workspace\n\nGet the details of a chat workspace by its unique identifier.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#DeleteChatRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteChat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteChatRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/chats/{workspace_uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete a chat workspace\n\nDelete a chat workspace and its settings by its unique identifier.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessage": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase2"
+ },
+ "Case3": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase3"
+ },
+ "Case4": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase4"
+ },
+ "Case5": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase5"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A message in the chat completion conversation. Tagged by `role` (system, user, assistant, tool, developer, or function)."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestDeveloperMessageContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestDeveloperMessageContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The contents of a developer message: either a text string or an array of text content parts."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageContentPartText": {
+ "type": "structure",
+ "members": {
+ "text": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A text content part of a message."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestDeveloperMessageContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageContentPartText"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase0Role": {
+ "type": "enum",
+ "members": {
+ "DEVELOPER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "developer"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase0": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatCompletionRequestDeveloperMessageContent",
+ "traits": {
+ "smithy.api#documentation": "The contents of the developer message.",
+ "smithy.api#required": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase0Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestSystemMessageContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestSystemMessageContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The contents of a system message: either a text string or an array of text content parts."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestSystemMessageContentPartType": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestSystemMessageContentPart": {
+ "type": "structure",
+ "members": {
+ "text": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestSystemMessageContentPartType",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestSystemMessageContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestSystemMessageContentPart"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of content parts with a defined type. For system messages, only type `text` is supported."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase1Role": {
+ "type": "enum",
+ "members": {
+ "SYSTEM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "system"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase1": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatCompletionRequestSystemMessageContent",
+ "traits": {
+ "smithy.api#documentation": "The contents of the system message.",
+ "smithy.api#required": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase1Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The contents of a user message: either a text string or an array of content parts (text, image, or audio)."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPart": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase2"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A content part in a user message (text, image, or audio)."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase0Type": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase0": {
+ "type": "structure",
+ "members": {
+ "text": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase0Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ImageUrl": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Either a URL of the image or the base64 encoded image data.",
+ "smithy.api#required": {}
+ }
+ },
+ "detail": {
+ "target": "com.meilisearch.api#ImageDetail",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "An image URL with optional detail level."
+ }
+ },
+ "com.meilisearch.api#ImageDetail": {
+ "type": "enum",
+ "members": {
+ "AUTO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auto"
+ }
+ },
+ "LOW": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "low"
+ }
+ },
+ "HIGH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "high"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Specifies the detail level of the image."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase1Type": {
+ "type": "enum",
+ "members": {
+ "IMAGE_URL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "image_url"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase1": {
+ "type": "structure",
+ "members": {
+ "image_url": {
+ "target": "com.meilisearch.api#ImageUrl",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase1Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#InputAudio": {
+ "type": "structure",
+ "members": {
+ "data": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Base64 encoded audio data.",
+ "smithy.api#required": {}
+ }
+ },
+ "format": {
+ "target": "com.meilisearch.api#InputAudioFormat",
+ "traits": {
+ "smithy.api#documentation": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Input audio data for an audio content part."
+ }
+ },
+ "com.meilisearch.api#InputAudioFormat": {
+ "type": "enum",
+ "members": {
+ "WAV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "wav"
+ }
+ },
+ "MP3": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mp3"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The format of the encoded audio data."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase2Type": {
+ "type": "enum",
+ "members": {
+ "INPUT_AUDIO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "input_audio"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase2": {
+ "type": "structure",
+ "members": {
+ "input_audio": {
+ "target": "com.meilisearch.api#InputAudio",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPartCase2Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestUserMessageContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContentPart"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text, image, or audio inputs."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase2Role": {
+ "type": "enum",
+ "members": {
+ "USER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "user"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase2": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatCompletionRequestUserMessageContent",
+ "traits": {
+ "smithy.api#documentation": "The contents of the user message.",
+ "smithy.api#required": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase2Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The contents of an assistant message: either a text string or an array of content parts (text or refusal)."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPart": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase1"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A content part in an assistant message (text or refusal)."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase0Type": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase0": {
+ "type": "structure",
+ "members": {
+ "text": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase0Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase1Type": {
+ "type": "enum",
+ "members": {
+ "REFUSAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "refusal"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase1": {
+ "type": "structure",
+ "members": {
+ "refusal": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The refusal message generated by the model.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPartCase1Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContentPart"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestAssistantMessageAudio": {
+ "type": "structure",
+ "members": {
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for a previous audio response from the model.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Data about a previous audio response from the model, used in multi-turn conversations."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionMessageToolCall": {
+ "type": "structure",
+ "members": {
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The ID of the tool call.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionToolType",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "function": {
+ "target": "com.meilisearch.api#FunctionCall",
+ "traits": {
+ "smithy.api#documentation": "The function that the model called.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A tool call generated by the model."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionToolType": {
+ "type": "enum",
+ "members": {
+ "FUNCTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "function"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of a tool. Currently, only `function` is supported."
+ }
+ },
+ "com.meilisearch.api#FunctionCall": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the function to call.",
+ "smithy.api#required": {}
+ }
+ },
+ "arguments": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The name and arguments of a function that should be called, as generated by the model."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase3ToolCallsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionMessageToolCall"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase3Role": {
+ "type": "enum",
+ "members": {
+ "ASSISTANT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "assistant"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase3": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageContent",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "refusal": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The refusal message by the assistant.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "audio": {
+ "target": "com.meilisearch.api#ChatCompletionRequestAssistantMessageAudio",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tool_calls": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase3ToolCallsList",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "function_call": {
+ "target": "com.meilisearch.api#FunctionCall",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase3Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestToolMessageContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionRequestToolMessageContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The contents of a tool message: either a text string or an array of text content parts."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestToolMessageContentPartType": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestToolMessageContentPart": {
+ "type": "structure",
+ "members": {
+ "text": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionRequestToolMessageContentPartType",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestToolMessageContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestToolMessageContentPart"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of content parts with a defined type. For tool messages, only type `text` is supported."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase4Role": {
+ "type": "enum",
+ "members": {
+ "TOOL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tool"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase4": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatCompletionRequestToolMessageContent",
+ "traits": {
+ "smithy.api#documentation": "The contents of the tool message.",
+ "smithy.api#required": {}
+ }
+ },
+ "tool_call_id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase4Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase5Role": {
+ "type": "enum",
+ "members": {
+ "FUNCTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "function"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionRequestMessageCase5": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The return value from the function call, to return to the model.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the function to call.",
+ "smithy.api#required": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageCase5Role",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatRequestMessagesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessage"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of messages comprising the conversation so far. Depending on the [model](https://platform.openai.com/docs/models) you use, different message types (modalities) are supported, like [text](https://platform.openai.com/docs/guides/text-generation), [images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio)."
+ }
+ },
+ "com.meilisearch.api#ReasoningEffort": {
+ "type": "enum",
+ "members": {
+ "LOW": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "low"
+ }
+ },
+ "MEDIUM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "medium"
+ }
+ },
+ "HIGH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "high"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Constrains effort on reasoning for reasoning models. Supported values are `low`, `medium`, and `high`."
+ }
+ },
+ "com.meilisearch.api#ChatRequestLogitBiasMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.\nMathematically, the bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection;\nvalues like -100 or 100 should result in a ban or exclusive selection of the relevant token."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionModalities": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ },
+ "AUDIO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "audio"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Output types that you would like the model to generate for this request.\n\nMost models are capable of generating text, which is the default: `[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate\naudio](https://platform.openai.com/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `[\"text\", \"audio\"]`"
+ }
+ },
+ "com.meilisearch.api#ChatRequestModalitiesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionModalities"
+ },
+ "traits": {
+ "smithy.api#documentation": "Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `[\"text\"]`."
+ }
+ },
+ "com.meilisearch.api#PredictionContentContent": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#PredictionContentContentCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly."
+ }
+ },
+ "com.meilisearch.api#PredictionContentContentCase1List": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionRequestMessageContentPartText"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs."
+ }
+ },
+ "com.meilisearch.api#PredictionContentType": {
+ "type": "enum",
+ "members": {
+ "CONTENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "content"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PredictionContent": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#PredictionContentContent",
+ "traits": {
+ "smithy.api#documentation": "The type of the predicted content you want to provide. This type is\ncurrently always `content`.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#PredictionContentType",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of the predicted content you want to provide. This type is\ncurrently always `content`."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionAudio": {
+ "type": "structure",
+ "members": {
+ "voice": {
+ "target": "com.meilisearch.api#ChatCompletionAudioVoice",
+ "traits": {
+ "smithy.api#documentation": "The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive).",
+ "smithy.api#required": {}
+ }
+ },
+ "format": {
+ "target": "com.meilisearch.api#ChatCompletionAudioFormat",
+ "traits": {
+ "smithy.api#documentation": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Parameters for audio output. Required when audio output is requested with `modalities: [\"audio\"]`."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionAudioVoice": {
+ "type": "enum",
+ "members": {
+ "ALLOY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "alloy"
+ }
+ },
+ "ASH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ash"
+ }
+ },
+ "BALLAD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ballad"
+ }
+ },
+ "CORAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "coral"
+ }
+ },
+ "ECHO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "echo"
+ }
+ },
+ "SAGE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sage"
+ }
+ },
+ "SHIMMER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "shimmer"
+ }
+ },
+ "VERSE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "verse"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The voice the model uses to respond in audio output."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionAudioFormat": {
+ "type": "enum",
+ "members": {
+ "WAV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "wav"
+ }
+ },
+ "MP3": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mp3"
+ }
+ },
+ "FLAC": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "flac"
+ }
+ },
+ "OPUS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "opus"
+ }
+ },
+ "PCM16": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pcm16"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`."
+ }
+ },
+ "com.meilisearch.api#ResponseFormat": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ResponseFormatCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ResponseFormatCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#ResponseFormatCase2"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "An object specifying the format that the model must output (text, JSON object, or JSON schema)."
+ }
+ },
+ "com.meilisearch.api#ResponseFormatCase0Type": {
+ "type": "enum",
+ "members": {
+ "TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "text"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ResponseFormatCase0": {
+ "type": "structure",
+ "members": {
+ "type": {
+ "target": "com.meilisearch.api#ResponseFormatCase0Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of response format being defined: `text`"
+ }
+ },
+ "com.meilisearch.api#ResponseFormatCase1Type": {
+ "type": "enum",
+ "members": {
+ "JSON_OBJECT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "json_object"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ResponseFormatCase1": {
+ "type": "structure",
+ "members": {
+ "type": {
+ "target": "com.meilisearch.api#ResponseFormatCase1Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of response format being defined: `json_object`"
+ }
+ },
+ "com.meilisearch.api#ResponseFormatJsonSchema": {
+ "type": "structure",
+ "members": {
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A description of what the response format is for, used by the model to determine how to respond in the format.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
+ "smithy.api#required": {}
+ }
+ },
+ "schema": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "The schema for the response format, described as a JSON Schema object."
+ }
+ },
+ "strict": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A JSON Schema-based response format specification for Structured Outputs."
+ }
+ },
+ "com.meilisearch.api#ResponseFormatCase2Type": {
+ "type": "enum",
+ "members": {
+ "JSON_SCHEMA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "json_schema"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ResponseFormatCase2": {
+ "type": "structure",
+ "members": {
+ "json_schema": {
+ "target": "com.meilisearch.api#ResponseFormatJsonSchema",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ResponseFormatCase2Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of response format being defined: `json_schema`"
+ }
+ },
+ "com.meilisearch.api#ServiceTier": {
+ "type": "enum",
+ "members": {
+ "AUTO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auto"
+ }
+ },
+ "DEFAULT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "default"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Specifies the latency tier to use for processing the request."
+ }
+ },
+ "com.meilisearch.api#Stop": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#StopCase1List"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Up to 4 sequences where the API will stop generating further tokens."
+ }
+ },
+ "com.meilisearch.api#StopCase1List": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionStreamOptions": {
+ "type": "structure",
+ "members": {
+ "include_usage": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Options for streaming response. Only set this when you set `stream: true`."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionTool": {
+ "type": "structure",
+ "members": {
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionToolType",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "function": {
+ "target": "com.meilisearch.api#FunctionObject",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A tool the model may call. Currently, only functions are supported as a tool."
+ }
+ },
+ "com.meilisearch.api#FunctionObject": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
+ "smithy.api#required": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A description of what the function does, used by the model to choose when and how to call the function.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "parameters": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list."
+ }
+ },
+ "strict": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling).",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A function definition for tool use, described as a JSON Schema object."
+ }
+ },
+ "com.meilisearch.api#ChatRequestToolsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionTool"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of tools the model may call. Currently, only functions are supported as a tool.\nUse this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionToolChoiceOption": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ChatCompletionToolChoiceOptionCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionToolChoiceOptionCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#ChatCompletionToolChoiceOptionCase2"
+ },
+ "Case3": {
+ "target": "com.meilisearch.api#ChatCompletionToolChoiceOptionCase3"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.present."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionToolChoiceOptionCase0": {
+ "type": "enum",
+ "members": {
+ "NONE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "none"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionToolChoiceOptionCase1": {
+ "type": "enum",
+ "members": {
+ "AUTO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auto"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionToolChoiceOptionCase2": {
+ "type": "enum",
+ "members": {
+ "REQUIRED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "required"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionNamedToolChoice": {
+ "type": "structure",
+ "members": {
+ "type": {
+ "target": "com.meilisearch.api#ChatCompletionToolType",
+ "traits": {
+ "smithy.api#documentation": "The type of the tool. Currently, only `function` is supported.",
+ "smithy.api#required": {}
+ }
+ },
+ "function": {
+ "target": "com.meilisearch.api#FunctionName",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Specifies a tool the model should use. Use to force the model to call a specific function."
+ }
+ },
+ "com.meilisearch.api#FunctionName": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the function to call.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A wrapper for a function name reference."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionToolChoiceOptionCase3": {
+ "type": "structure",
+ "members": {
+ "named": {
+ "target": "com.meilisearch.api#ChatCompletionNamedToolChoice",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatCompletionFunctionCall": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#ChatCompletionFunctionCallCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#ChatCompletionFunctionCallCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#ChatCompletionFunctionCallCase2"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Deprecated in favor of `tool_choice`. Controls which (if any) function is called by the model."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionFunctionCallCase0": {
+ "type": "enum",
+ "members": {
+ "NONE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "none"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The model does not call a function, and responds to the end-user."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionFunctionCallCase1": {
+ "type": "enum",
+ "members": {
+ "AUTO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auto"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The model can pick between an end-user or calling a function."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionFunctionCallCase2Function": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Forces the model to call the specified function."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionFunctionCallCase2": {
+ "type": "structure",
+ "members": {
+ "Function": {
+ "target": "com.meilisearch.api#ChatCompletionFunctionCallCase2Function",
+ "traits": {
+ "smithy.api#documentation": "Forces the model to call the specified function.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Forces the model to call the specified function."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionFunctions": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
+ "smithy.api#required": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A description of what the function does, used by the model to choose when and how to call the function.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "parameters": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Deprecated: A function the model may generate JSON inputs for. Use `ChatCompletionTool` instead."
+ }
+ },
+ "com.meilisearch.api#ChatRequestFunctionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionFunctions"
+ },
+ "traits": {
+ "smithy.api#documentation": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for."
+ }
+ },
+ "com.meilisearch.api#ChatRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ },
+ "messages": {
+ "target": "com.meilisearch.api#ChatRequestMessagesList",
+ "traits": {
+ "smithy.api#documentation": "A list of messages comprising the conversation so far. Depending on the [model](https://platform.openai.com/docs/models) you use, different message types (modalities) are supported, like [text](https://platform.openai.com/docs/guides/text-generation), [images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio).",
+ "smithy.api#required": {}
+ }
+ },
+ "model": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "ID of the model to use.\nSee the [model endpoint compatibility](https://platform.openai.com/docs/models#model-endpoint-compatibility) table for details on which models work with the Chat API.",
+ "smithy.api#required": {}
+ }
+ },
+ "store": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether or not to store the output of this chat completion request\n\nfor use in our [model distillation](https://platform.openai.com/docs/guides/distillation) or [evals](https://platform.openai.com/docs/guides/evals) products.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "reasoning_effort": {
+ "target": "com.meilisearch.api#ReasoningEffort",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "metadata": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Developer-defined tags and values used for filtering completions in the [dashboard](https://platform.openai.com/chat-completions)."
+ }
+ },
+ "frequency_penalty": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "logit_bias": {
+ "target": "com.meilisearch.api#ChatRequestLogitBiasMap",
+ "traits": {
+ "smithy.api#documentation": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.\nMathematically, the bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection;\nvalues like -100 or 100 should result in a ban or exclusive selection of the relevant token.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "logprobs": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "top_logprobs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "max_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the chat completion.\n\nThis value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API.\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o1 series models](https://platform.openai.com/docs/guides/reasoning).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "max_completion_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "n": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "modalities": {
+ "target": "com.meilisearch.api#ChatRequestModalitiesList",
+ "traits": {
+ "smithy.api#documentation": "Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `[\"text\"]`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "prediction": {
+ "target": "com.meilisearch.api#PredictionContent",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "audio": {
+ "target": "com.meilisearch.api#ChatCompletionAudio",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "presence_penalty": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "response_format": {
+ "target": "com.meilisearch.api#ResponseFormat",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "seed": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": " This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests\nwith the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "service_tier": {
+ "target": "com.meilisearch.api#ServiceTier",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "stop": {
+ "target": "com.meilisearch.api#Stop",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "stream": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "If set, partial message deltas will be sent, like in ChatGPT.\nTokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "stream_options": {
+ "target": "com.meilisearch.api#ChatCompletionStreamOptions",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "temperature": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\nwhile lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "top_p": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability mass.\nSo 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\n We generally recommend altering this or `temperature` but not both.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tools": {
+ "target": "com.meilisearch.api#ChatRequestToolsList",
+ "traits": {
+ "smithy.api#documentation": "A list of tools the model may call. Currently, only functions are supported as a tool.\nUse this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tool_choice": {
+ "target": "com.meilisearch.api#ChatCompletionToolChoiceOption",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "parallel_tool_calls": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling) during tool use.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "user": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "function_call": {
+ "target": "com.meilisearch.api#ChatCompletionFunctionCall",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "functions": {
+ "target": "com.meilisearch.api#ChatRequestFunctionsList",
+ "traits": {
+ "smithy.api#documentation": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#CreateChatCompletionResponse": {
+ "type": "structure",
+ "members": {
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A unique identifier for the chat completion.",
+ "smithy.api#required": {}
+ }
+ },
+ "choices": {
+ "target": "com.meilisearch.api#CreateChatCompletionResponseChoicesList",
+ "traits": {
+ "smithy.api#documentation": "A list of chat completion choices. Can be more than one if `n` is greater than 1.",
+ "smithy.api#required": {}
+ }
+ },
+ "created": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The Unix timestamp (in seconds) of when the chat completion was created.",
+ "smithy.api#required": {}
+ }
+ },
+ "model": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The model used for the chat completion.",
+ "smithy.api#required": {}
+ }
+ },
+ "service_tier": {
+ "target": "com.meilisearch.api#ServiceTierResponse",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "system_fingerprint": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "object": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The object type, which is always `chat.completion`.",
+ "smithy.api#required": {}
+ }
+ },
+ "usage": {
+ "target": "com.meilisearch.api#CompletionUsage",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents a chat completion response returned by model, based on the provided input."
+ }
+ },
+ "com.meilisearch.api#ChatChoice": {
+ "type": "structure",
+ "members": {
+ "index": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The index of the choice in the list of choices.",
+ "smithy.api#required": {}
+ }
+ },
+ "message": {
+ "target": "com.meilisearch.api#ChatCompletionResponseMessage",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "finish_reason": {
+ "target": "com.meilisearch.api#FinishReason",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "logprobs": {
+ "target": "com.meilisearch.api#ChatChoiceLogprobs",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A chat completion choice generated by the model."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionResponseMessage": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The contents of the message.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "refusal": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The refusal message generated by the model.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tool_calls": {
+ "target": "com.meilisearch.api#ChatCompletionResponseMessageToolCallsList",
+ "traits": {
+ "smithy.api#documentation": "The tool calls generated by the model, such as function calls.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "role": {
+ "target": "com.meilisearch.api#Role",
+ "traits": {
+ "smithy.api#documentation": "The role of the author of this message.",
+ "smithy.api#required": {}
+ }
+ },
+ "function_call": {
+ "target": "com.meilisearch.api#FunctionCall",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "audio": {
+ "target": "com.meilisearch.api#ChatCompletionResponseMessageAudio",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A chat completion message generated by the model."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionResponseMessageToolCallsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionMessageToolCall"
+ },
+ "traits": {
+ "smithy.api#documentation": "The tool calls generated by the model, such as function calls."
+ }
+ },
+ "com.meilisearch.api#Role": {
+ "type": "enum",
+ "members": {
+ "SYSTEM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "system"
+ }
+ },
+ "USER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "user"
+ }
+ },
+ "ASSISTANT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "assistant"
+ }
+ },
+ "TOOL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tool"
+ }
+ },
+ "FUNCTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "function"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The role of the author of a message."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionResponseMessageAudio": {
+ "type": "structure",
+ "members": {
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for this audio response.",
+ "smithy.api#required": {}
+ }
+ },
+ "expires_at": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations.",
+ "smithy.api#required": {}
+ }
+ },
+ "data": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Base64 encoded audio bytes generated by the model, in the format specified in the request.",
+ "smithy.api#required": {}
+ }
+ },
+ "transcript": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Transcript of the audio generated by the model.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Audio data in a chat completion response message."
+ }
+ },
+ "com.meilisearch.api#FinishReason": {
+ "type": "enum",
+ "members": {
+ "STOP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "stop"
+ }
+ },
+ "LENGTH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "length"
+ }
+ },
+ "TOOL_CALLS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tool_calls"
+ }
+ },
+ "CONTENT_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "content_filter"
+ }
+ },
+ "FUNCTION_CALL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "function_call"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The reason the model stopped generating tokens."
+ }
+ },
+ "com.meilisearch.api#ChatChoiceLogprobs": {
+ "type": "structure",
+ "members": {
+ "content": {
+ "target": "com.meilisearch.api#ChatChoiceLogprobsContentList",
+ "traits": {
+ "smithy.api#documentation": "A list of message content tokens with log probability information.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "refusal": {
+ "target": "com.meilisearch.api#ChatChoiceLogprobsRefusalList",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Log probability information for a chat completion choice."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionTokenLogprob": {
+ "type": "structure",
+ "members": {
+ "token": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The token.",
+ "smithy.api#required": {}
+ }
+ },
+ "logprob": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.",
+ "smithy.api#required": {}
+ }
+ },
+ "bytes": {
+ "target": "com.meilisearch.api#ChatCompletionTokenLogprobBytesList",
+ "traits": {
+ "smithy.api#documentation": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "top_logprobs": {
+ "target": "com.meilisearch.api#ChatCompletionTokenLogprobTopLogprobsList",
+ "traits": {
+ "smithy.api#documentation": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Log probability information for an output token."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionTokenLogprobBytesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."
+ }
+ },
+ "com.meilisearch.api#TopLogprobs": {
+ "type": "structure",
+ "members": {
+ "token": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The token.",
+ "smithy.api#required": {}
+ }
+ },
+ "logprob": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "The log probability of this token.",
+ "smithy.api#required": {}
+ }
+ },
+ "bytes": {
+ "target": "com.meilisearch.api#TopLogprobsBytesList",
+ "traits": {
+ "smithy.api#documentation": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A most likely token and its log probability at a given position."
+ }
+ },
+ "com.meilisearch.api#TopLogprobsBytesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionTokenLogprobTopLogprobsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#TopLogprobs"
+ },
+ "traits": {
+ "smithy.api#documentation": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned."
+ }
+ },
+ "com.meilisearch.api#ChatChoiceLogprobsContentList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionTokenLogprob"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of message content tokens with log probability information."
+ }
+ },
+ "com.meilisearch.api#ChatChoiceLogprobsRefusalList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatCompletionTokenLogprob"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CreateChatCompletionResponseChoicesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ChatChoice"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of chat completion choices. Can be more than one if `n` is greater than 1."
+ }
+ },
+ "com.meilisearch.api#ServiceTierResponse": {
+ "type": "enum",
+ "members": {
+ "SCALE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "scale"
+ }
+ },
+ "DEFAULT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "default"
+ }
+ },
+ "AUTO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auto"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The service tier used for processing the request, as returned in the response."
+ }
+ },
+ "com.meilisearch.api#CompletionUsage": {
+ "type": "structure",
+ "members": {
+ "prompt_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of tokens in the prompt.",
+ "smithy.api#required": {}
+ }
+ },
+ "completion_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of tokens in the generated completion.",
+ "smithy.api#required": {}
+ }
+ },
+ "total_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of tokens used in the request (prompt + completion).",
+ "smithy.api#required": {}
+ }
+ },
+ "prompt_tokens_details": {
+ "target": "com.meilisearch.api#PromptTokensDetails",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "completion_tokens_details": {
+ "target": "com.meilisearch.api#CompletionTokensDetails",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Usage statistics for the completion request."
+ }
+ },
+ "com.meilisearch.api#PromptTokensDetails": {
+ "type": "structure",
+ "members": {
+ "audio_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Audio input tokens present in the prompt.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "cached_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Cached tokens present in the prompt.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Breakdown of tokens used in a completion."
+ }
+ },
+ "com.meilisearch.api#CompletionTokensDetails": {
+ "type": "structure",
+ "members": {
+ "accepted_prediction_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "audio_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Audio input tokens generated by the model.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "reasoning_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Tokens generated by the model for reasoning.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rejected_prediction_tokens": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": " When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context\nwindow limits.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Breakdown of tokens used in a completion."
+ }
+ },
+ "com.meilisearch.api#Chat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ChatRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#CreateChatCompletionResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/chats/{workspace_uid}/chat/completions",
+ "code": 200
+ },
+ "smithy.api#documentation": "Request a chat completion\n\nAnswer a conversational question with the OpenAI-compatible chat completions API,\nusing the documents of the authorized indexes as context.\nOnly streamed responses (`stream: true`) are supported.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#GetSettingsRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetSettings": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetSettingsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/chats/{workspace_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get settings of a chat workspace\n\nGet the settings of a chat workspace, such as the LLM source, the base prompts,\nand the search parameters. The API key is never returned.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#ChatCompletionSource": {
+ "type": "enum",
+ "members": {
+ "OPENAI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "openAi"
+ }
+ },
+ "MISTRAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mistral"
+ }
+ },
+ "AZUREOPENAI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "azureOpenAi"
+ }
+ },
+ "VLLM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "vLlm"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "LLM provider for chat completions"
+ }
+ },
+ "com.meilisearch.api#PatchSettingsRequestPrompts": {
+ "type": "structure",
+ "members": {
+ "system": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "System prompt for the LLM",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchDescription": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Description of the search function for the LLM",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchQParam": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Description of the query parameter for search",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchFilterParam": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Description of the filter parameter for search",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchIndexUidParam": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Custom prompts for chat completions"
+ }
+ },
+ "com.meilisearch.api#PatchSettingsRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ },
+ "source": {
+ "target": "com.meilisearch.api#ChatCompletionSource",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "orgId": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Organization ID for the LLM provider",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "projectId": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Project ID for the LLM provider",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "apiVersion": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "API version for the LLM provider",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "deploymentId": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Deployment ID for Azure OpenAI",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "baseUrl": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Base URL for the LLM API",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "apiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "API key for authentication with the LLM provider",
+ "com.distilled.openapi#nullable": {},
+ "smithy.api#sensitive": {}
+ }
+ },
+ "prompts": {
+ "target": "com.meilisearch.api#PatchSettingsRequestPrompts",
+ "traits": {
+ "smithy.api#documentation": "Custom prompts for chat completions",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchSettings": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchSettingsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/chats/{workspace_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update settings of a chat workspace\n\nPartially update the settings of a chat workspace, such as the LLM source, the base prompts,\nand the search parameters. Fields set to `null` are reset to their default value,\nand missing fields are left unchanged.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#ResetSettingsRequest": {
+ "type": "structure",
+ "members": {
+ "workspace_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier of the chat workspace."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#ResetSettings": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ResetSettingsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/chats/{workspace_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset the settings of a chat workspace\n\nReset all the settings of a chat workspace to their default value.\n\nThis route is only available when the `chatCompletions` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#CreateDump": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/dumps",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create dump\n\nTrigger a dump creation process. When complete, a dump file is written to the [dump directory](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#dump-directory). The directory is created if it does not exist."
+ }
+ },
+ "com.meilisearch.api#ListRulesFilter": {
+ "type": "structure",
+ "members": {
+ "query": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Only include rules whose names match these patterns (e.g. `[\"black-friday\", \"promo*\"]`).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "active": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include rules that are active (true) or not active (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ListRulesRequest": {
+ "type": "structure",
+ "members": {
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of rules to skip. Defaults to 0."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of rules to return. Default to 20."
+ }
+ },
+ "filter": {
+ "target": "com.meilisearch.api#ListRulesFilter",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PaginationViewDynamicSearchRule": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsList",
+ "traits": {
+ "smithy.api#documentation": "Items for the current page.",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of items skipped.",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of items returned.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of items matching the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#Conditions": {
+ "type": "structure",
+ "members": {
+ "time": {
+ "target": "com.meilisearch.api#TimeCondition",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "query": {
+ "target": "com.meilisearch.api#QueryCondition",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filter": {
+ "target": "com.meilisearch.api#FilterCondition",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#TimeCondition": {
+ "type": "structure",
+ "members": {
+ "start": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Start of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "end": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "End of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#QueryCondition": {
+ "type": "structure",
+ "members": {
+ "isEmpty": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "If present and non-null, specifies either:\n\n- That this rule can only be active when the search query is empty\n- That this rule can only be active when the search query is non-empty (contains at least one word)",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "words": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "If present and non-null, specifies that the rule can only be active if all the specified words are\npresent in the search query.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FilterCondition": {
+ "type": "structure",
+ "members": {
+ "values": {
+ "target": "com.meilisearch.api#FilterConditionValuesMap"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FilterConditionValuesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RuleAction": {
+ "type": "structure",
+ "members": {
+ "selector": {
+ "target": "com.meilisearch.api#Selector",
+ "traits": {
+ "smithy.api#documentation": "Target document selector for this action.",
+ "smithy.api#required": {}
+ }
+ },
+ "action": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Action payload to apply to the selected document.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#Selector": {
+ "type": "structure",
+ "members": {
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsItemActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#RuleAction"
+ },
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches."
+ }
+ },
+ "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsItem": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the dynamic search rule.",
+ "smithy.api#required": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Human-readable description of the dynamic search rule.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "lastUpdatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Date time of the last update of this rule.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "precedence": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Precedence of the dynamic search rule. Lower numeric values take precedence over higher\nones. If omitted, the rule is treated as having the lowest precedence. This precedence is\nused to resolve conflicts between matching rules:\n- If the same document is selected by multiple rules, the smallest `priority` number wins\n- If different documents are pinned to the same position, they are ordered by ascending `priority`",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "active": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the dynamic search rule is active."
+ }
+ },
+ "conditions": {
+ "target": "com.meilisearch.api#Conditions",
+ "traits": {
+ "smithy.api#documentation": "Conditions that must match before the dynamic search rule applies."
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsItemActionsList",
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#PaginationViewDynamicSearchRuleResultsItem"
+ },
+ "traits": {
+ "smithy.api#documentation": "Items for the current page."
+ }
+ },
+ "com.meilisearch.api#ListRules": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ListRulesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewDynamicSearchRule"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/dynamic-search-rules",
+ "code": 200
+ },
+ "smithy.api#documentation": "List search rules\n\nReturn all search rules configured on the instance."
+ }
+ },
+ "com.meilisearch.api#ClearRules": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/dynamic-search-rules",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete all search rules.\n\nThis will delete **all** the currently defined search rules."
+ }
+ },
+ "com.meilisearch.api#GetRuleRequest": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the search rule."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DynamicSearchRule": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the dynamic search rule.",
+ "smithy.api#required": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Human-readable description of the dynamic search rule.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "lastUpdatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Date time of the last update of this rule.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "precedence": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Precedence of the dynamic search rule. Lower numeric values take precedence over higher\nones. If omitted, the rule is treated as having the lowest precedence. This precedence is\nused to resolve conflicts between matching rules:\n- If the same document is selected by multiple rules, the smallest `priority` number wins\n- If different documents are pinned to the same position, they are ordered by ascending `priority`",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "active": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the dynamic search rule is active."
+ }
+ },
+ "conditions": {
+ "target": "com.meilisearch.api#Conditions",
+ "traits": {
+ "smithy.api#documentation": "Conditions that must match before the dynamic search rule applies."
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#DynamicSearchRuleActionsList",
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DynamicSearchRuleActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#RuleAction"
+ },
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches."
+ }
+ },
+ "com.meilisearch.api#GetRule": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetRuleRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#DynamicSearchRule"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/dynamic-search-rules/{uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get a search rule\n\nRetrieve a single search rule by its unique identifier."
+ }
+ },
+ "com.meilisearch.api#UpdateOrCreateRuleRequestActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#RuleAction"
+ },
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches."
+ }
+ },
+ "com.meilisearch.api#UpdateOrCreateRuleRequest": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the search rule."
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Human-readable description of the dynamic search rule.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "precedence": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Precedence of the dynamic search rule. Lower numeric values take precedence over higher\nones. If omitted, the rule is treated as having the lowest precedence. This precedence is\nused to resolve conflicts between matching rules:\n- If the same document is selected by multiple rules, the smallest `priority` number wins\n- If different documents are pinned to the same position, they are ordered by ascending `priority`",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "active": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the dynamic search rule is active.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "conditions": {
+ "target": "com.meilisearch.api#Conditions",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#UpdateOrCreateRuleRequestActionsList",
+ "traits": {
+ "smithy.api#documentation": "Actions to apply when the dynamic search rule matches.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#UpdateOrCreateRule": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#UpdateOrCreateRuleRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/dynamic-search-rules/{uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create or update a search rule\n\nPartially update a search rule by replacing the provided fields. If the rule doesn't exist, it will be created."
+ }
+ },
+ "com.meilisearch.api#DeleteRuleRequest": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the search rule."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteRule": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteRuleRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/dynamic-search-rules/{uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete a search rule\n\nDelete a search rule by its unique identifier."
+ }
+ },
+ "com.meilisearch.api#RuntimeTogglableFeatures": {
+ "type": "structure",
+ "members": {
+ "metrics": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the /metrics endpoint for Prometheus metrics",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "logsRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the /logs route for log configuration",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tasksStreamingRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the `GET /tasks/stream` and `GET /batches/stream` SSE-based routes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "editDocumentsByFunction": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable document editing via JavaScript functions",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "containsFilter": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the CONTAINS filter operator",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "dynamicSearchRules": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable dynamic search rules and the `/dynamic-search-rules` routes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "network": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable network features for distributed search",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "getTaskDocumentsRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the route to get documents from tasks",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "taskQueueCompactionRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the route to compact the task queue database",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "compositeEmbedders": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable composite embedders for multi-source embeddings",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "chatCompletions": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable chat completion capabilities",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "multimodal": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable multimodal search with images and other media",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "foreignKeys": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable foreign key support for document hydration",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableDocumentsFetchQueue": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Disable documents fetch queue",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "legacySearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable legacy search pipeline",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "renderRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the `POST /render-template` route",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Experimental features that can be toggled at runtime"
+ }
+ },
+ "com.meilisearch.api#GetFeatures": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#RuntimeTogglableFeatures"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/experimental-features",
+ "code": 200
+ },
+ "smithy.api#documentation": "List experimental features\n\nReturn all experimental features that can be toggled via this API, and whether each one is currently enabled or disabled."
+ }
+ },
+ "com.meilisearch.api#PatchFeaturesRequest": {
+ "type": "structure",
+ "members": {
+ "metrics": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the /metrics endpoint for Prometheus metrics",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "logsRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the /logs route for log configuration",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "tasksStreamingRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the `GET /tasks/stream` and `GET /batches/stream` SSE-based routes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "editDocumentsByFunction": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable document editing via JavaScript functions",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "containsFilter": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the CONTAINS filter operator",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "dynamicSearchRules": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable dynamic search rules and the `/dynamic-search-rules` routes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "network": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable network features for distributed search",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "getTaskDocumentsRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the route to get documents from tasks",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "taskQueueCompactionRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the route to compact the task queue database",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "compositeEmbedders": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable composite embedders for multi-source embeddings",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "chatCompletions": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable chat completion capabilities",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "multimodal": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable multimodal search with images and other media",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "foreignKeys": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable foreign key support for document hydration",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableDocumentsFetchQueue": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Disable documents fetch queue",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "legacySearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable legacy search pipeline",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "renderRoute": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable the `POST /render-template` route",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchFeatures": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchFeaturesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#RuntimeTogglableFeatures"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/experimental-features",
+ "code": 200
+ },
+ "smithy.api#documentation": "Configure experimental features\n\nEnable or disable experimental features at runtime."
+ }
+ },
+ "com.meilisearch.api#ExportIndexSettings": {
+ "type": "structure",
+ "members": {
+ "filter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Filter expression to select which documents to export",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "overrideSettings": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to override settings on the destination index",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Export settings for a specific index"
+ }
+ },
+ "com.meilisearch.api#ExportRequestIndexesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ExportIndexSettings"
+ },
+ "traits": {
+ "smithy.api#documentation": "Index patterns to export with their settings"
+ }
+ },
+ "com.meilisearch.api#ExportRequest": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL of the destination Meilisearch instance"
+ }
+ },
+ "apiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "API key for authenticating with the destination instance",
+ "com.distilled.openapi#nullable": {},
+ "smithy.api#sensitive": {}
+ }
+ },
+ "payloadSize": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Maximum payload size per request",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexes": {
+ "target": "com.meilisearch.api#ExportRequestIndexesMap",
+ "traits": {
+ "smithy.api#documentation": "Index patterns to export with their settings",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Export": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ExportRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/export",
+ "code": 200
+ },
+ "smithy.api#documentation": "Export to a remote Meilisearch\n\nTrigger an export that sends documents and settings from this instance to a remote Meilisearch server. Configure the remote URL and optional API key in the request body."
+ }
+ },
+ "com.meilisearch.api#HealthResponse": {
+ "type": "structure",
+ "members": {
+ "status": {
+ "target": "com.meilisearch.api#HealthStatus",
+ "traits": {
+ "smithy.api#documentation": "The status of the instance.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#HealthStatus": {
+ "type": "enum",
+ "members": {
+ "AVAILABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "available"
+ }
+ },
+ "MUSTRESTART": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mustRestart"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetHealth": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#HealthResponse"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/health",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get health\n\nThe health check endpoint enables you to periodically test the health of your Meilisearch instance. Returns a simple status indicating that the server is available.\n\nThe engine will return `available` status with a `200` status code when the instance is healthy.\nIt will return `mustRestart` status with a `500` status code if the instance requires a restart.\nThis restart is required after a compaction of the task queue for example."
+ }
+ },
+ "com.meilisearch.api#ListIndexesRequest": {
+ "type": "structure",
+ "members": {
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "offset",
+ "smithy.api#documentation": "The number of indexes to skip before starting to retrieve anything."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "The number of indexes to retrieve."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PaginationViewIndexView": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#PaginationViewIndexViewResultsList",
+ "traits": {
+ "smithy.api#documentation": "Items for the current page.",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of items skipped.",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of items returned.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of items matching the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewIndexViewResultsItem": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for the index. Once created, it cannot be changed",
+ "smithy.api#required": {}
+ }
+ },
+ "createdAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Creation date of the index, represented in RFC 3339 format",
+ "smithy.api#required": {}
+ }
+ },
+ "updatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Latest date of index update, represented in RFC 3339 format",
+ "smithy.api#required": {}
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "An index containing searchable documents"
+ }
+ },
+ "com.meilisearch.api#PaginationViewIndexViewResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#PaginationViewIndexViewResultsItem"
+ },
+ "traits": {
+ "smithy.api#documentation": "Items for the current page."
+ }
+ },
+ "com.meilisearch.api#ListIndexes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ListIndexesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewIndexView"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes",
+ "code": 200
+ },
+ "smithy.api#documentation": "List all indexes\n\nReturns a paginated list of indexes. Use the `offset` and `limit` query parameters to page through results."
+ }
+ },
+ "com.meilisearch.api#CreateIndexRequest": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for the index",
+ "smithy.api#required": {}
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#CreateIndex": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#CreateIndexRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create index\n\nCreate a new index with an optional [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key).\n\nIf no primary key is provided, Meilisearch will [infer one](https://www.meilisearch.com/docs/learn/getting_started/primary_key#meilisearch-guesses-your-primary-key) from the first batch of documents."
+ }
+ },
+ "com.meilisearch.api#GetIndexRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#IndexView": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for the index. Once created, it cannot be changed",
+ "smithy.api#required": {}
+ }
+ },
+ "createdAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Creation date of the index, represented in RFC 3339 format",
+ "smithy.api#required": {}
+ }
+ },
+ "updatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Latest date of index update, represented in RFC 3339 format",
+ "smithy.api#required": {}
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "An index containing searchable documents"
+ }
+ },
+ "com.meilisearch.api#GetIndex": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetIndexRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#IndexView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get index\n\nRetrieve the metadata of a single index: its uid, [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key), and creation/update timestamps."
+ }
+ },
+ "com.meilisearch.api#UpdateIndexRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "New [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "New uid for the index (for renaming)",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#UpdateIndex": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#UpdateIndexRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update index\n\nUpdate the [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) or uid of an index.\n\nReturns an error if the index does not exist or if it already contains documents ([primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) cannot be changed in that case)."
+ }
+ },
+ "com.meilisearch.api#DeleteIndexRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteIndex": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteIndexRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete index\n\nPermanently delete an index and all its documents, settings, and task history."
+ }
+ },
+ "com.meilisearch.api#CompactRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Compact": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#CompactRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/compact",
+ "code": 200
+ },
+ "smithy.api#documentation": "Compact index\n\nTrigger a compaction process on the specified index.\n\nCompaction reorganizes the index database to reclaim space and improve read performance."
+ }
+ },
+ "com.meilisearch.api#GetDocumentsRequestFieldsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetDocumentsRequestIdsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetDocumentsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "offset",
+ "smithy.api#documentation": "Number of documents to skip in the response. Use this parameter\ntogether with `limit` to paginate through large document sets. For\nexample, to get documents 21-40, set `offset=20` and `limit=20`.\nDefaults to `0`."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of documents to return in a single response. Use\ntogether with `offset` for pagination. Defaults to `20`."
+ }
+ },
+ "fields": {
+ "target": "com.meilisearch.api#GetDocumentsRequestFieldsList",
+ "traits": {
+ "smithy.api#httpQuery": "fields",
+ "smithy.api#documentation": "Comma-separated list of document attributes to include in the\nresponse. Use `*` to retrieve all attributes. By default, all\nattributes are returned. Example: `title,description,price`."
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "retrieveVectors",
+ "smithy.api#documentation": "When `true`, includes vector embeddings in the response for documents\nthat have them. This is useful when you need to inspect or export\nvector data. Defaults to `false`."
+ }
+ },
+ "ids": {
+ "target": "com.meilisearch.api#GetDocumentsRequestIdsList",
+ "traits": {
+ "smithy.api#httpQuery": "ids",
+ "smithy.api#documentation": "Comma-separated list of document IDs to retrieve. Only documents with\nmatching IDs will be returned. If not specified, all documents\nmatching other criteria are returned."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "filter",
+ "smithy.api#documentation": "Filter expression to select which documents to return. Attributes must be added to the\n`filterableAttributes` index setting before they can be used in filters. Only accepts\nstring expressions (not array syntax). Example: `genres = action AND rating > 4`."
+ }
+ },
+ "sort": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "sort",
+ "smithy.api#documentation": "Attribute(s) to sort the documents by. Format: `attribute:asc` or\n`attribute:desc`. Multiple sort criteria can be comma-separated.\nExample: `price:asc,rating:desc`."
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "useNetwork",
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PaginationViewValue": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#PaginationViewValueResultsList",
+ "traits": {
+ "smithy.api#documentation": "Items for the current page.",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of items skipped.",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of items returned.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of items matching the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewValueResultsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Items for the current page."
+ }
+ },
+ "com.meilisearch.api#GetDocuments": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetDocumentsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewValue"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/documents",
+ "code": 200
+ },
+ "smithy.api#documentation": "List documents with GET\n\nRetrieve documents in batches using query parameters for offset, limit, and optional filtering.\n\n**Deprecated:** This endpoint will be deprecated in a future release. Use `POST /indexes/{index_uid}/documents/fetch` instead, which supports more parameters and array-based filter expressions.\n\n**Note:** Documents are not returned following the order of their primary keys."
+ }
+ },
+ "com.meilisearch.api#ReplaceDocumentsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "primaryKey",
+ "smithy.api#documentation": "The [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) field for uniquely identifying each document.\nThis parameter is optional and can only be set the first time documents are added to an index.\nSubsequent attempts to specify it will be ignored if the primary key has already been set."
+ }
+ },
+ "csvDelimiter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "csvDelimiter",
+ "smithy.api#documentation": "Customize the CSV column delimiter when importing CSV documents. Must be a single ASCII\ncharacter. Only valid when the content type is `text/csv`; using this parameter with\n`application/json` or `application/x-ndjson` will return an error. Default: `,`."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ },
+ "skipCreation": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "skipCreation",
+ "smithy.api#documentation": "When set to `true`, only updates existing documents and skips creating\nnew ones. Documents that don't already exist in the index will be\nignored. This is useful for partial updates where you only want to\nmodify existing records without adding new ones."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#ReplaceDocuments": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ReplaceDocumentsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/documents",
+ "code": 200
+ },
+ "smithy.api#documentation": "Add or replace documents\n\nAdd a list of documents or replace them if they already exist.\n\nIf you send an already existing document (same id) the whole existing document will be\noverwritten by the new document. Fields previously in the document not present in the new\ndocument are removed.\n\nIf the provided index does not exist, it will be created.\n\n**Accepted content types:** `application/json`, `application/x-ndjson`, `text/csv`.\n\n**Note:** Use the reserved `_geo` object to add geo coordinates: `{\"lat\": 48.8566, \"lng\": 2.3522}`.\n\nFor a partial update see [add or update documents route](/docs/reference/api/documents/add-or-update-documents)."
+ }
+ },
+ "com.meilisearch.api#UpdateDocumentsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "primaryKey",
+ "smithy.api#documentation": "The [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) field for uniquely identifying each document.\nThis parameter is optional and can only be set the first time documents are added to an index.\nSubsequent attempts to specify it will be ignored if the primary key has already been set."
+ }
+ },
+ "csvDelimiter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "csvDelimiter",
+ "smithy.api#documentation": "Customize the CSV column delimiter when importing CSV documents. Must be a single ASCII\ncharacter. Only valid when the content type is `text/csv`; using this parameter with\n`application/json` or `application/x-ndjson` will return an error. Default: `,`."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ },
+ "skipCreation": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "skipCreation",
+ "smithy.api#documentation": "When set to `true`, only updates existing documents and skips creating\nnew ones. Documents that don't already exist in the index will be\nignored. This is useful for partial updates where you only want to\nmodify existing records without adding new ones."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#UpdateDocuments": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#UpdateDocumentsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/documents",
+ "code": 200
+ },
+ "smithy.api#documentation": "Add or update documents\n\nAdd a list of documents or update them if they already exist.\n\nIf you send an already existing document (same id) the old document will\nbe only partially updated according to the fields of the new document.\nThus, any fields not present in the new document are kept and remained\nunchanged.\n\n**Important:** Partial updates apply only to top-level fields. Updating an object attribute\nreplaces the entire object, removing any subfields not present in the update. Dot notation\nin an update request creates a new flat attribute rather than updating an existing nested field.\n\nIf the provided index does not exist, it will be created.\n\n**Accepted content types:** `application/json`, `application/x-ndjson`, `text/csv`.\n\n**Note:** Use the reserved `_geo` object to add geo coordinates: `{\"lat\": 48.8566, \"lng\": 2.3522}`.\n\nTo completely overwrite a document, see [add or replace documents route](/docs/reference/api/documents/add-or-replace-documents)."
+ }
+ },
+ "com.meilisearch.api#ClearAllDocumentsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#ClearAllDocuments": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ClearAllDocumentsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/documents",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete all documents\n\nPermanently delete all documents in the specified index. Settings and index metadata are preserved."
+ }
+ },
+ "com.meilisearch.api#DeleteDocumentsByFilterRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter expression to match documents for deletion. Attributes must be in\n`filterableAttributes` before they can be used. Accepts a string or an array of arrays.\nSending an empty filter will return a `bad_request` error.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteDocumentsByFilter": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteDocumentsByFilterRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/documents/delete",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete documents by filter\n\nDelete all documents in the index that match the given filter expression."
+ }
+ },
+ "com.meilisearch.api#DeleteDocumentsBatchRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteDocumentsBatchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#DeleteDocumentsBatchRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteDocumentsBatch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteDocumentsBatchRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/documents/delete-batch",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete documents by batch\n\nDelete multiple documents in one request by providing an array of [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values."
+ }
+ },
+ "com.meilisearch.api#EditDocumentsByFunctionRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter expression to select which documents to edit. If omitted, all documents in the\nindex will be processed. Attributes must be in `filterableAttributes` to be used."
+ }
+ },
+ "context": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Arbitrary data to pass into the function scope. By default the function only has access\nto the current document being edited via the `doc` variable."
+ }
+ },
+ "function": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A [RHAI](https://rhai.rs) function string to apply to each document. The function has\naccess to a `doc` variable representing the current document. Modify `doc` fields to\nupdate the document. Return `null` or `()` to delete the document.\nTo enable this feature: `PATCH /experimental-features/ {\"editDocumentsByFunction\": true}`.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#EditDocumentsByFunction": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#EditDocumentsByFunctionRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/documents/edit",
+ "code": 200
+ },
+ "smithy.api#documentation": "Edit documents by function\n\nUse a [RHAI function](https://rhai.rs/book/engine/hello-world.html) to edit one or more documents directly in Meilisearch. The function receives each document and returns the modified document.\n\nThis feature is experimental and must be enabled through the experimental route."
+ }
+ },
+ "com.meilisearch.api#DocumentsByQueryPostRequestFieldsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of document attributes to include in the response. If not\nspecified, all attributes listed in the `displayedAttributes` setting\nare returned. Use this to reduce response size by only requesting the\nfields you need. Example: `[\"title\", \"description\", \"price\"]`."
+ }
+ },
+ "com.meilisearch.api#DocumentsByQueryPostRequestIdsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of specific document IDs to retrieve. Only documents with\nmatching [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values will be returned. If not specified, all\ndocuments matching other criteria are returned. This is useful for\nfetching specific known documents."
+ }
+ },
+ "com.meilisearch.api#DocumentsByQueryPostRequestSortList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of attributes to sort the documents by. Each entry should be in\nthe format `attribute:direction` where direction is either `asc`\n(ascending) or `desc` (descending). Example: `[\"price:asc\",\n\"rating:desc\"]` sorts by price ascending, then by rating descending."
+ }
+ },
+ "com.meilisearch.api#DocumentsByQueryPostRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents to skip in the response. Use together with `limit`\nfor pagination through large document sets. For example, to get\ndocuments 151-170, set `offset=150` and `limit=20`. Defaults to `0`."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents to return in a single response. Use\ntogether with `offset` for pagination. Higher values return more\nresults but may increase response time and memory usage. Defaults to\n`20`."
+ }
+ },
+ "fields": {
+ "target": "com.meilisearch.api#DocumentsByQueryPostRequestFieldsList",
+ "traits": {
+ "smithy.api#documentation": "Array of document attributes to include in the response. If not\nspecified, all attributes listed in the `displayedAttributes` setting\nare returned. Use this to reduce response size by only requesting the\nfields you need. Example: `[\"title\", \"description\", \"price\"]`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, includes the vector embeddings in the response for\ndocuments that have them. This is useful when you need to inspect or\nexport vector data. Note that this can significantly increase response\nsize. Defaults to `false`."
+ }
+ },
+ "ids": {
+ "target": "com.meilisearch.api#DocumentsByQueryPostRequestIdsList",
+ "traits": {
+ "smithy.api#documentation": "Array of specific document IDs to retrieve. Only documents with\nmatching [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values will be returned. If not specified, all\ndocuments matching other criteria are returned. This is useful for\nfetching specific known documents.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter expression to select which documents to return. Attributes must be added to the\n`filterableAttributes` index setting before they can be used in filters. Accepts a string\nor an array of arrays of strings for AND/OR combinations.\nExample string: `\"genres = action AND rating > 4\"`.\nExample array: `[[\"genres = action\", \"genres = comedy\"], \"rating > 4\"]` (inner array = OR, outer = AND)."
+ }
+ },
+ "sort": {
+ "target": "com.meilisearch.api#DocumentsByQueryPostRequestSortList",
+ "traits": {
+ "smithy.api#documentation": "Array of attributes to sort the documents by. Each entry should be in\nthe format `attribute:direction` where direction is either `asc`\n(ascending) or `desc` (descending). Example: `[\"price:asc\",\n\"rating:desc\"]` sorts by price ascending, then by rating descending.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DocumentsByQueryPost": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DocumentsByQueryPostRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewValue"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/documents/fetch",
+ "code": 200
+ },
+ "smithy.api#documentation": "List documents with POST\n\nRetrieve a set of documents with optional filtering, sorting, and pagination. Use the request\nbody to specify filters, sort order, and which fields to return.\n\n**Note:** Sending an empty payload (`{}`) returns all documents in the index.\n\n**Note:** Documents are not returned following the order of their primary keys."
+ }
+ },
+ "com.meilisearch.api#GetDocumentRequestFieldsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetDocumentRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "document_id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The document identifier."
+ }
+ },
+ "fields": {
+ "target": "com.meilisearch.api#GetDocumentRequestFieldsList",
+ "traits": {
+ "smithy.api#httpQuery": "fields",
+ "smithy.api#documentation": "Comma-separated list of document attributes to include in the\nresponse. Use `*` to retrieve all attributes. By default, all\nattributes listed in the `displayedAttributes` setting are returned.\nExample: `title,description,price`."
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "retrieveVectors",
+ "smithy.api#documentation": "When `true`, includes the vector embeddings in the response for this\ndocument. This is useful when you need to inspect or export vector\ndata. Note that this can significantly increase response size if the\ndocument has multiple embedders configured. Defaults to `false`."
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "useNetwork",
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetDocumentResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetDocument": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetDocumentRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetDocumentResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/documents/{document_id}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get document\n\nRetrieve a single document by its [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value."
+ }
+ },
+ "com.meilisearch.api#DeleteDocumentRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "document_id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Document identifier."
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "customMetadata",
+ "smithy.api#documentation": "A string that can be used to identify and filter tasks. This metadata\nis stored with the task and returned in task responses. Useful for\ntracking tasks from external systems or associating tasks with\nspecific operations in your application."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteDocument": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteDocumentRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/documents/{document_id}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete document\n\nDelete a single document by its [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key)."
+ }
+ },
+ "com.meilisearch.api#SearchRequestVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {
+ "smithy.api#documentation": "Custom query vector for semantic search"
+ }
+ },
+ "com.meilisearch.api#HybridQuery": {
+ "type": "structure",
+ "members": {
+ "semanticRatio": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Balance between keyword (0.0) and semantic (1.0) search."
+ }
+ },
+ "embedder": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the embedder from the index embedders setting (`embedder` in JSON). Used to vectorize the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Hybrid search: balance between keyword and semantic search."
+ }
+ },
+ "com.meilisearch.api#MatchingStrategy": {
+ "type": "enum",
+ "members": {
+ "LAST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "last"
+ }
+ },
+ "ALL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "all"
+ }
+ },
+ "FREQUENCY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "frequency"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Strategy used to match query terms within documents"
+ }
+ },
+ "com.meilisearch.api#SearchRequestAttributesToSearchOnList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Restrict search to specified attributes"
+ }
+ },
+ "com.meilisearch.api#Locale": {
+ "type": "enum",
+ "members": {
+ "AF": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "af"
+ }
+ },
+ "AK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ak"
+ }
+ },
+ "AM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "am"
+ }
+ },
+ "AR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ar"
+ }
+ },
+ "AZ": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "az"
+ }
+ },
+ "BE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "be"
+ }
+ },
+ "BN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bn"
+ }
+ },
+ "BG": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bg"
+ }
+ },
+ "CA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ca"
+ }
+ },
+ "CS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "cs"
+ }
+ },
+ "DA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "da"
+ }
+ },
+ "DE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "de"
+ }
+ },
+ "EL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "el"
+ }
+ },
+ "EN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "en"
+ }
+ },
+ "EO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "eo"
+ }
+ },
+ "ET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "et"
+ }
+ },
+ "FI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fi"
+ }
+ },
+ "FR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fr"
+ }
+ },
+ "GU": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "gu"
+ }
+ },
+ "HE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "he"
+ }
+ },
+ "HI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hi"
+ }
+ },
+ "HR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hr"
+ }
+ },
+ "HU": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hu"
+ }
+ },
+ "HY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hy"
+ }
+ },
+ "ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "id"
+ }
+ },
+ "IT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "it"
+ }
+ },
+ "JV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "jv"
+ }
+ },
+ "JA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ja"
+ }
+ },
+ "KN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "kn"
+ }
+ },
+ "KA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ka"
+ }
+ },
+ "KM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "km"
+ }
+ },
+ "KO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ko"
+ }
+ },
+ "LA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "la"
+ }
+ },
+ "LV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "lv"
+ }
+ },
+ "LT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "lt"
+ }
+ },
+ "ML": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ml"
+ }
+ },
+ "MR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mr"
+ }
+ },
+ "MK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mk"
+ }
+ },
+ "MY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "my"
+ }
+ },
+ "NE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ne"
+ }
+ },
+ "NL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "nl"
+ }
+ },
+ "NB": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "nb"
+ }
+ },
+ "OR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "or"
+ }
+ },
+ "PA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pa"
+ }
+ },
+ "FA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fa"
+ }
+ },
+ "PL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pl"
+ }
+ },
+ "PT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pt"
+ }
+ },
+ "RO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ro"
+ }
+ },
+ "RU": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ru"
+ }
+ },
+ "SI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "si"
+ }
+ },
+ "SK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sk"
+ }
+ },
+ "SL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sl"
+ }
+ },
+ "SN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sn"
+ }
+ },
+ "ES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "es"
+ }
+ },
+ "SR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sr"
+ }
+ },
+ "SV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sv"
+ }
+ },
+ "TA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ta"
+ }
+ },
+ "TE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "te"
+ }
+ },
+ "TL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tl"
+ }
+ },
+ "TH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "th"
+ }
+ },
+ "TK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tk"
+ }
+ },
+ "TR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tr"
+ }
+ },
+ "UK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "uk"
+ }
+ },
+ "UR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ur"
+ }
+ },
+ "UZ": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "uz"
+ }
+ },
+ "VI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "vi"
+ }
+ },
+ "YI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "yi"
+ }
+ },
+ "ZH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "zh"
+ }
+ },
+ "ZU": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "zu"
+ }
+ },
+ "AFR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "afr"
+ }
+ },
+ "AKA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "aka"
+ }
+ },
+ "AMH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "amh"
+ }
+ },
+ "ARA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ara"
+ }
+ },
+ "AZE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "aze"
+ }
+ },
+ "BEL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bel"
+ }
+ },
+ "BEN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ben"
+ }
+ },
+ "BUL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bul"
+ }
+ },
+ "CAT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "cat"
+ }
+ },
+ "CES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ces"
+ }
+ },
+ "DAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dan"
+ }
+ },
+ "DEU": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "deu"
+ }
+ },
+ "ELL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ell"
+ }
+ },
+ "ENG": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "eng"
+ }
+ },
+ "EPO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "epo"
+ }
+ },
+ "EST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "est"
+ }
+ },
+ "FIN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fin"
+ }
+ },
+ "FRA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fra"
+ }
+ },
+ "GUJ": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "guj"
+ }
+ },
+ "HEB": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "heb"
+ }
+ },
+ "HIN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hin"
+ }
+ },
+ "HRV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hrv"
+ }
+ },
+ "HUN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hun"
+ }
+ },
+ "HYE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "hye"
+ }
+ },
+ "IND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ind"
+ }
+ },
+ "ITA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ita"
+ }
+ },
+ "JAV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "jav"
+ }
+ },
+ "JPN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "jpn"
+ }
+ },
+ "KAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "kan"
+ }
+ },
+ "KAT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "kat"
+ }
+ },
+ "KHM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "khm"
+ }
+ },
+ "KOR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "kor"
+ }
+ },
+ "LAT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "lat"
+ }
+ },
+ "LAV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "lav"
+ }
+ },
+ "LIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "lit"
+ }
+ },
+ "MAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mal"
+ }
+ },
+ "MAR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mar"
+ }
+ },
+ "MKD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mkd"
+ }
+ },
+ "MYA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "mya"
+ }
+ },
+ "NEP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "nep"
+ }
+ },
+ "NLD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "nld"
+ }
+ },
+ "NOB": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "nob"
+ }
+ },
+ "ORI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ori"
+ }
+ },
+ "PAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pan"
+ }
+ },
+ "PES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pes"
+ }
+ },
+ "POL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "pol"
+ }
+ },
+ "POR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "por"
+ }
+ },
+ "RON": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ron"
+ }
+ },
+ "RUS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "rus"
+ }
+ },
+ "SIN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sin"
+ }
+ },
+ "SLK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "slk"
+ }
+ },
+ "SLV": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "slv"
+ }
+ },
+ "SNA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sna"
+ }
+ },
+ "SPA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "spa"
+ }
+ },
+ "SRP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "srp"
+ }
+ },
+ "SWE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "swe"
+ }
+ },
+ "TAM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tam"
+ }
+ },
+ "TEL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tel"
+ }
+ },
+ "TGL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tgl"
+ }
+ },
+ "THA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tha"
+ }
+ },
+ "TUK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tuk"
+ }
+ },
+ "TUR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tur"
+ }
+ },
+ "UKR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ukr"
+ }
+ },
+ "URD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "urd"
+ }
+ },
+ "UZB": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "uzb"
+ }
+ },
+ "VIE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "vie"
+ }
+ },
+ "YID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "yid"
+ }
+ },
+ "ZHO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "zho"
+ }
+ },
+ "ZUL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "zul"
+ }
+ },
+ "CMN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "cmn"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchRequestLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Locale"
+ },
+ "traits": {
+ "smithy.api#documentation": "Languages to use for query processing"
+ }
+ },
+ "com.meilisearch.api#SearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "facetQuery": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string to search for matching facet values. If not specified, Meilisearch returns all facet values for the `facetName`, limited to 100 results. Note: only the first word is used for matching.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetName": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the facet attribute to search. Must be present in the index's `filterableAttributes` list.",
+ "smithy.api#required": {}
+ }
+ },
+ "q": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string to filter the underlying documents before computing facet values. This affects which facet values appear and their counts, but does not filter the facet values themselves.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "vector": {
+ "target": "com.meilisearch.api#SearchRequestVectorList",
+ "traits": {
+ "smithy.api#documentation": "Custom query vector for semantic search",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "media": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Multimodal content for AI-powered search"
+ }
+ },
+ "hybrid": {
+ "target": "com.meilisearch.api#HybridQuery",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter expression to restrict which documents are considered when computing facet values. Attributes must be in `filterableAttributes` before they can be used in filters."
+ }
+ },
+ "matchingStrategy": {
+ "target": "com.meilisearch.api#MatchingStrategy"
+ },
+ "attributesToSearchOn": {
+ "target": "com.meilisearch.api#SearchRequestAttributesToSearchOnList",
+ "traits": {
+ "smithy.api#documentation": "Restrict search to specified attributes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Minimum ranking score threshold (0.0 to 1.0) that documents must\nachieve to be considered when computing facet counts. Documents with\nscores below this threshold are excluded from facet value counts.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "locales": {
+ "target": "com.meilisearch.api#SearchRequestLocalesList",
+ "traits": {
+ "smithy.api#documentation": "Languages to use for query processing",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "exhaustiveFacetCount": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Return exhaustive facet count instead of an estimate",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#FacetSearchResult": {
+ "type": "structure",
+ "members": {
+ "facetHits": {
+ "target": "com.meilisearch.api#FacetSearchResultFacetHitsList",
+ "traits": {
+ "smithy.api#documentation": "Array of matching facet values with their document counts, sorted lexicographically\nin ascending order (or by count if `sortFacetValuesBy` is set to `\"count\"`).",
+ "smithy.api#required": {}
+ }
+ },
+ "facetQuery": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The original `facetQuery` from the request. `null` if no query was provided.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Time in milliseconds Meilisearch took to process the request.",
+ "smithy.api#required": {}
+ }
+ },
+ "remoteErrors": {
+ "target": "com.meilisearch.api#FacetSearchResultRemoteErrorsMap",
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Only present in federated search when some remotes failed.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Result of a facet search operation."
+ }
+ },
+ "com.meilisearch.api#FacetValueHitSchema": {
+ "type": "structure",
+ "members": {
+ "value": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The facet value that matched the query.",
+ "smithy.api#required": {}
+ }
+ },
+ "count": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents with this facet value among the search results.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Schema representation of a facet value hit (for OpenAPI documentation only)."
+ }
+ },
+ "com.meilisearch.api#FacetSearchResultFacetHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#FacetValueHitSchema"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of matching facet values with their document counts, sorted lexicographically\nin ascending order (or by count if `sortFacetValuesBy` is set to `\"count\"`)."
+ }
+ },
+ "com.meilisearch.api#ResponseError": {
+ "type": "structure",
+ "members": {
+ "message": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The error message.",
+ "smithy.api#required": {}
+ }
+ },
+ "code": {
+ "target": "com.meilisearch.api#Code",
+ "traits": {
+ "smithy.api#documentation": "The error code.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#ErrorType",
+ "traits": {
+ "smithy.api#documentation": "The error type.",
+ "smithy.api#required": {}
+ }
+ },
+ "link": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A link to the documentation about this specific error.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#Code": {
+ "type": "enum",
+ "members": {
+ "API_KEY_ALREADY_EXISTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "api_key_already_exists"
+ }
+ },
+ "API_KEY_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "api_key_not_found"
+ }
+ },
+ "INDEX_SCOPED_API_KEY_WITH_GLOBAL_ACTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_scoped_api_key_with_global_action"
+ }
+ },
+ "BAD_PARAMETER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bad_parameter"
+ }
+ },
+ "BAD_REQUEST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "bad_request"
+ }
+ },
+ "DATABASE_SIZE_LIMIT_REACHED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "database_size_limit_reached"
+ }
+ },
+ "DOCUMENT_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "document_not_found"
+ }
+ },
+ "DUMP_ALREADY_PROCESSING": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dump_already_processing"
+ }
+ },
+ "DUMP_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dump_not_found"
+ }
+ },
+ "DUMP_PROCESS_FAILED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dump_process_failed"
+ }
+ },
+ "DUPLICATE_INDEX_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "duplicate_index_found"
+ }
+ },
+ "IMMUTABLE_API_KEY_ACTIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_actions"
+ }
+ },
+ "IMMUTABLE_API_KEY_CREATED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_created_at"
+ }
+ },
+ "IMMUTABLE_API_KEY_EXPIRES_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_expires_at"
+ }
+ },
+ "IMMUTABLE_API_KEY_INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_indexes"
+ }
+ },
+ "IMMUTABLE_API_KEY_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_key"
+ }
+ },
+ "IMMUTABLE_API_KEY_UID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_uid"
+ }
+ },
+ "IMMUTABLE_API_KEY_UPDATED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_api_key_updated_at"
+ }
+ },
+ "IMMUTABLE_INDEX_CREATED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_index_created_at"
+ }
+ },
+ "IMMUTABLE_INDEX_UPDATED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_index_updated_at"
+ }
+ },
+ "IMPORT_TASK_ALREADY_RECEIVED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "import_task_already_received"
+ }
+ },
+ "IMPORT_TASK_UNKNOWN_REMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "import_task_unknown_remote"
+ }
+ },
+ "RECEIVE_IMPORT_FINISHED_UNKNOWN_REMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "receive_import_finished_unknown_remote"
+ }
+ },
+ "IMPORT_TASK_WITHOUT_NETWORK_TASK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "import_task_without_network_task"
+ }
+ },
+ "INDEX_ALREADY_EXISTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_already_exists"
+ }
+ },
+ "INDEX_CREATION_FAILED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_creation_failed"
+ }
+ },
+ "INDEX_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_not_found"
+ }
+ },
+ "INDEX_PRIMARY_KEY_ALREADY_EXISTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_primary_key_already_exists"
+ }
+ },
+ "INDEX_PRIMARY_KEY_MULTIPLE_CANDIDATES_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_primary_key_multiple_candidates_found"
+ }
+ },
+ "INDEX_PRIMARY_KEY_NO_CANDIDATE_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "index_primary_key_no_candidate_found"
+ }
+ },
+ "INTERNAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "internal"
+ }
+ },
+ "INVALID_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key"
+ }
+ },
+ "INVALID_API_KEY_ACTIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_actions"
+ }
+ },
+ "INVALID_API_KEY_DESCRIPTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_description"
+ }
+ },
+ "INVALID_API_KEY_EXPIRES_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_expires_at"
+ }
+ },
+ "INVALID_API_KEY_INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_indexes"
+ }
+ },
+ "INVALID_API_KEY_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_limit"
+ }
+ },
+ "INVALID_API_KEY_NAME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_name"
+ }
+ },
+ "INVALID_API_KEY_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_offset"
+ }
+ },
+ "INVALID_API_KEY_UID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_api_key_uid"
+ }
+ },
+ "INVALID_CONTENT_TYPE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_content_type"
+ }
+ },
+ "INVALID_DOCUMENT_CSV_DELIMITER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_csv_delimiter"
+ }
+ },
+ "INVALID_DOCUMENT_FIELDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_fields"
+ }
+ },
+ "INVALID_DOCUMENT_RETRIEVE_VECTORS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_retrieve_vectors"
+ }
+ },
+ "MISSING_DOCUMENT_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_document_filter"
+ }
+ },
+ "MISSING_DOCUMENT_EDITION_FUNCTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_document_edition_function"
+ }
+ },
+ "INCONSISTENT_DOCUMENT_CHANGE_HEADERS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "inconsistent_document_change_headers"
+ }
+ },
+ "INVALID_DOCUMENT_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_filter"
+ }
+ },
+ "INVALID_DOCUMENT_SORT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_sort"
+ }
+ },
+ "INVALID_DOCUMENT_USE_NETWORK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_use_network"
+ }
+ },
+ "INVALID_DOCUMENT_RETRIEVE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_retrieve"
+ }
+ },
+ "INVALID_DOCUMENT_GEO_FIELD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_geo_field"
+ }
+ },
+ "INVALID_DOCUMENT_GEOJSON_FIELD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_geojson_field"
+ }
+ },
+ "INVALID_HEADER_VALUE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_header_value"
+ }
+ },
+ "INVALID_VECTOR_DIMENSIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_vector_dimensions"
+ }
+ },
+ "INVALID_VECTORS_TYPE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_vectors_type"
+ }
+ },
+ "INVALID_DOCUMENT_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_id"
+ }
+ },
+ "INVALID_DOCUMENT_IDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_ids"
+ }
+ },
+ "INVALID_DOCUMENT_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_limit"
+ }
+ },
+ "INVALID_DOCUMENT_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_offset"
+ }
+ },
+ "INVALID_SEARCH_EMBEDDER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_embedder"
+ }
+ },
+ "INVALID_SIMILAR_EMBEDDER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_embedder"
+ }
+ },
+ "INVALID_SEARCH_HYBRID_QUERY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_hybrid_query"
+ }
+ },
+ "INVALID_INDEX_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_limit"
+ }
+ },
+ "INVALID_INDEX_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_offset"
+ }
+ },
+ "INVALID_INDEX_PRIMARY_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_primary_key"
+ }
+ },
+ "INVALID_INDEX_CUSTOM_METADATA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_custom_metadata"
+ }
+ },
+ "INVALID_SKIP_CREATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_skip_creation"
+ }
+ },
+ "INVALID_INDEX_UID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_uid"
+ }
+ },
+ "INVALID_MULTI_SEARCH_FACETS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_facets"
+ }
+ },
+ "INVALID_MULTI_SEARCH_FACETS_BY_INDEX": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_facets_by_index"
+ }
+ },
+ "INVALID_MULTI_SEARCH_FACET_ORDER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_facet_order"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_PERSONALIZATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_personalization"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_SHOW_PERFORMANCE_DETAILS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_show_performance_details"
+ }
+ },
+ "INVALID_MULTI_SEARCH_FEDERATED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_federated"
+ }
+ },
+ "INVALID_MULTI_SEARCH_FEDERATION_OPTIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_federation_options"
+ }
+ },
+ "INVALID_MULTI_SEARCH_MAX_VALUES_PER_FACET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_max_values_per_facet"
+ }
+ },
+ "INVALID_MULTI_SEARCH_MERGE_FACETS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_merge_facets"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_FACETS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_facets"
+ }
+ },
+ "INVALID_MULTI_SEARCH_DISTINCT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_distinct"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_PAGINATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_pagination"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_RANKING_RULES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_ranking_rules"
+ }
+ },
+ "INVALID_MULTI_SEARCH_QUERY_POSITION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_query_position"
+ }
+ },
+ "INVALID_MULTI_SEARCH_REMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_remote"
+ }
+ },
+ "INVALID_MULTI_SEARCH_WEIGHT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_multi_search_weight"
+ }
+ },
+ "INVALID_NETWORK_LEADER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_leader"
+ }
+ },
+ "INVALID_NETWORK_REMOTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_remotes"
+ }
+ },
+ "INVALID_NETWORK_SHARDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_shards"
+ }
+ },
+ "INVALID_NETWORK_SELF": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_self"
+ }
+ },
+ "INVALID_NETWORK_SEARCH_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_search_api_key"
+ }
+ },
+ "INVALID_NETWORK_WRITE_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_write_api_key"
+ }
+ },
+ "INVALID_NETWORK_URL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_network_url"
+ }
+ },
+ "INVALID_SEARCH_ATTRIBUTES_TO_SEARCH_ON": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_attributes_to_search_on"
+ }
+ },
+ "INVALID_SEARCH_ATTRIBUTES_TO_CROP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_attributes_to_crop"
+ }
+ },
+ "INVALID_SEARCH_ATTRIBUTES_TO_HIGHLIGHT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_attributes_to_highlight"
+ }
+ },
+ "INVALID_SIMILAR_ATTRIBUTES_TO_RETRIEVE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_attributes_to_retrieve"
+ }
+ },
+ "INVALID_SIMILAR_RETRIEVE_VECTORS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_retrieve_vectors"
+ }
+ },
+ "INVALID_SEARCH_ATTRIBUTES_TO_RETRIEVE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_attributes_to_retrieve"
+ }
+ },
+ "INVALID_SEARCH_RANKING_SCORE_THRESHOLD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_ranking_score_threshold"
+ }
+ },
+ "INVALID_SIMILAR_RANKING_SCORE_THRESHOLD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_ranking_score_threshold"
+ }
+ },
+ "INVALID_SEARCH_RETRIEVE_VECTORS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_retrieve_vectors"
+ }
+ },
+ "INVALID_SEARCH_CROP_LENGTH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_crop_length"
+ }
+ },
+ "INVALID_SEARCH_CROP_MARKER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_crop_marker"
+ }
+ },
+ "INVALID_SEARCH_FACETS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_facets"
+ }
+ },
+ "INVALID_SEARCH_SEMANTIC_RATIO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_semantic_ratio"
+ }
+ },
+ "INVALID_SEARCH_LOCALES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_locales"
+ }
+ },
+ "INVALID_FACET_SEARCH_EXHAUSTIVE_FACET_COUNT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_facet_search_exhaustive_facet_count"
+ }
+ },
+ "INVALID_FACET_SEARCH_FACET_NAME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_facet_search_facet_name"
+ }
+ },
+ "INVALID_SIMILAR_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_id"
+ }
+ },
+ "INVALID_SEARCH_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_filter"
+ }
+ },
+ "INVALID_SIMILAR_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_filter"
+ }
+ },
+ "INVALID_SEARCH_HIGHLIGHT_POST_TAG": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_highlight_post_tag"
+ }
+ },
+ "INVALID_SEARCH_HIGHLIGHT_PRE_TAG": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_highlight_pre_tag"
+ }
+ },
+ "INVALID_SEARCH_HITS_PER_PAGE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_hits_per_page"
+ }
+ },
+ "INVALID_SIMILAR_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_limit"
+ }
+ },
+ "INVALID_SEARCH_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_limit"
+ }
+ },
+ "INVALID_SEARCH_MATCHING_STRATEGY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_matching_strategy"
+ }
+ },
+ "INVALID_SIMILAR_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_offset"
+ }
+ },
+ "INVALID_SEARCH_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_offset"
+ }
+ },
+ "INVALID_SEARCH_PAGE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_page"
+ }
+ },
+ "INVALID_SEARCH_Q": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_q"
+ }
+ },
+ "INVALID_FACET_SEARCH_QUERY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_facet_search_query"
+ }
+ },
+ "INVALID_FACET_SEARCH_NAME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_facet_search_name"
+ }
+ },
+ "FACET_SEARCH_DISABLED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "facet_search_disabled"
+ }
+ },
+ "INVALID_SEARCH_VECTOR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_vector"
+ }
+ },
+ "INVALID_SEARCH_MEDIA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_media"
+ }
+ },
+ "INVALID_SEARCH_SHOW_MATCHES_POSITION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_show_matches_position"
+ }
+ },
+ "INVALID_SEARCH_SHOW_RANKING_SCORE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_show_ranking_score"
+ }
+ },
+ "INVALID_SIMILAR_SHOW_RANKING_SCORE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_show_ranking_score"
+ }
+ },
+ "INVALID_SEARCH_SHOW_RANKING_SCORE_DETAILS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_show_ranking_score_details"
+ }
+ },
+ "INVALID_SEARCH_SHOW_PERFORMANCE_DETAILS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_show_performance_details"
+ }
+ },
+ "INVALID_SEARCH_USE_NETWORK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_use_network"
+ }
+ },
+ "INVALID_SIMILAR_SHOW_RANKING_SCORE_DETAILS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_show_ranking_score_details"
+ }
+ },
+ "INVALID_SIMILAR_SHOW_PERFORMANCE_DETAILS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_similar_show_performance_details"
+ }
+ },
+ "INVALID_SEARCH_SORT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_sort"
+ }
+ },
+ "INVALID_SEARCH_DISTINCT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_distinct"
+ }
+ },
+ "INVALID_SEARCH_PERSONALIZE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_personalize"
+ }
+ },
+ "INVALID_SEARCH_PERSONALIZE_USER_CONTEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_personalize_user_context"
+ }
+ },
+ "INVALID_SEARCH_MEDIA_AND_VECTOR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_search_media_and_vector"
+ }
+ },
+ "INVALID_SETTINGS_DISPLAYED_ATTRIBUTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_displayed_attributes"
+ }
+ },
+ "INVALID_SETTINGS_DISTINCT_ATTRIBUTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_distinct_attribute"
+ }
+ },
+ "INVALID_SETTINGS_PROXIMITY_PRECISION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_proximity_precision"
+ }
+ },
+ "INVALID_SETTINGS_FACET_SEARCH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_facet_search"
+ }
+ },
+ "INVALID_SETTINGS_PREFIX_SEARCH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_prefix_search"
+ }
+ },
+ "INVALID_SETTINGS_FACETING": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_faceting"
+ }
+ },
+ "INVALID_SETTINGS_FILTERABLE_ATTRIBUTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_filterable_attributes"
+ }
+ },
+ "INVALID_SETTINGS_FOREIGN_KEYS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_foreign_keys"
+ }
+ },
+ "INVALID_SETTINGS_PAGINATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_pagination"
+ }
+ },
+ "INVALID_SETTINGS_SEARCH_CUTOFF_MS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_search_cutoff_ms"
+ }
+ },
+ "INVALID_SETTINGS_EMBEDDERS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_embedders"
+ }
+ },
+ "INVALID_SETTINGS_RANKING_RULES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_ranking_rules"
+ }
+ },
+ "INVALID_SETTINGS_SEARCHABLE_ATTRIBUTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_searchable_attributes"
+ }
+ },
+ "INVALID_SETTINGS_SORTABLE_ATTRIBUTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_sortable_attributes"
+ }
+ },
+ "INVALID_SETTINGS_STOP_WORDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_stop_words"
+ }
+ },
+ "INVALID_SETTINGS_NON_SEPARATOR_TOKENS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_non_separator_tokens"
+ }
+ },
+ "INVALID_SETTINGS_SEPARATOR_TOKENS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_separator_tokens"
+ }
+ },
+ "INVALID_SETTINGS_DICTIONARY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_dictionary"
+ }
+ },
+ "INVALID_SETTINGS_SYNONYMS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_synonyms"
+ }
+ },
+ "INVALID_SETTINGS_TYPO_TOLERANCE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_typo_tolerance"
+ }
+ },
+ "INVALID_SETTINGS_LOCALIZED_ATTRIBUTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_localized_attributes"
+ }
+ },
+ "INVALID_STATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_state"
+ }
+ },
+ "INVALID_STATS_SHOW_INTERNAL_DATABASE_SIZES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_stats_show_internal_database_sizes"
+ }
+ },
+ "INVALID_STATS_SIZE_FORMAT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_stats_size_format"
+ }
+ },
+ "INVALID_STORE_FILE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_store_file"
+ }
+ },
+ "INVALID_SWAP_DUPLICATE_INDEX_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_swap_duplicate_index_found"
+ }
+ },
+ "INVALID_SWAP_INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_swap_indexes"
+ }
+ },
+ "INVALID_SWAP_RENAME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_swap_rename"
+ }
+ },
+ "INVALID_TASK_AFTER_ENQUEUED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_after_enqueued_at"
+ }
+ },
+ "INVALID_TASK_AFTER_FINISHED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_after_finished_at"
+ }
+ },
+ "INVALID_TASK_AFTER_STARTED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_after_started_at"
+ }
+ },
+ "INVALID_TASK_BEFORE_ENQUEUED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_before_enqueued_at"
+ }
+ },
+ "INVALID_TASK_BEFORE_FINISHED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_before_finished_at"
+ }
+ },
+ "INVALID_TASK_BEFORE_STARTED_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_before_started_at"
+ }
+ },
+ "INVALID_TASK_CANCELED_BY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_canceled_by"
+ }
+ },
+ "INVALID_TASK_FROM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_from"
+ }
+ },
+ "INVALID_TASK_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_limit"
+ }
+ },
+ "INVALID_TASK_REVERSE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_reverse"
+ }
+ },
+ "INVALID_TASK_STATUSES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_statuses"
+ }
+ },
+ "INVALID_TASK_TYPES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_types"
+ }
+ },
+ "INVALID_TASK_UIDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_task_uids"
+ }
+ },
+ "INVALID_BATCH_UIDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_batch_uids"
+ }
+ },
+ "IO_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "io_error"
+ }
+ },
+ "FEATURE_NOT_ENABLED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "feature_not_enabled"
+ }
+ },
+ "MALFORMED_PAYLOAD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "malformed_payload"
+ }
+ },
+ "MAX_FIELDS_LIMIT_EXCEEDED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "max_fields_limit_exceeded"
+ }
+ },
+ "MISSING_API_KEY_ACTIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_api_key_actions"
+ }
+ },
+ "MISSING_API_KEY_EXPIRES_AT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_api_key_expires_at"
+ }
+ },
+ "MISSING_API_KEY_INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_api_key_indexes"
+ }
+ },
+ "MISSING_AUTHORIZATION_HEADER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_authorization_header"
+ }
+ },
+ "MISSING_CONTENT_TYPE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_content_type"
+ }
+ },
+ "MISSING_DOCUMENT_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_document_id"
+ }
+ },
+ "MISSING_FACET_SEARCH_FACET_NAME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_facet_search_facet_name"
+ }
+ },
+ "MISSING_INDEX_UID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_index_uid"
+ }
+ },
+ "MISSING_MASTER_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_master_key"
+ }
+ },
+ "MISSING_NETWORK_URL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_network_url"
+ }
+ },
+ "MISSING_PAYLOAD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_payload"
+ }
+ },
+ "MISSING_SEARCH_HYBRID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_search_hybrid"
+ }
+ },
+ "MISSING_SWAP_INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_swap_indexes"
+ }
+ },
+ "MISSING_TASK_FILTERS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "missing_task_filters"
+ }
+ },
+ "NETWORK_VERSION_MISMATCH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "network_version_mismatch"
+ }
+ },
+ "NO_SPACE_LEFT_ON_DEVICE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "no_space_left_on_device"
+ }
+ },
+ "NOT_LEADER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "not_leader"
+ }
+ },
+ "PAYLOAD_TOO_LARGE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "payload_too_large"
+ }
+ },
+ "REMOTE_BAD_RESPONSE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_bad_response"
+ }
+ },
+ "REMOTE_BAD_REQUEST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_bad_request"
+ }
+ },
+ "UNKNOWN_REMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unknown_remote"
+ }
+ },
+ "REMOTE_COULD_NOT_SEND_REQUEST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_could_not_send_request"
+ }
+ },
+ "REMOTE_INVALID_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_invalid_api_key"
+ }
+ },
+ "REMOTE_REMOTE_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_remote_error"
+ }
+ },
+ "REMOTE_TIMEOUT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "remote_timeout"
+ }
+ },
+ "TOO_MANY_SEARCH_REQUESTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "too_many_search_requests"
+ }
+ },
+ "TASK_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "task_not_found"
+ }
+ },
+ "TASK_FILE_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "task_file_not_found"
+ }
+ },
+ "BATCH_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "batch_not_found"
+ }
+ },
+ "TOO_MANY_OPEN_FILES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "too_many_open_files"
+ }
+ },
+ "TOO_MANY_VECTORS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "too_many_vectors"
+ }
+ },
+ "UNEXPECTED_NETWORK_PREVIOUS_REMOTES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unexpected_network_previous_remotes"
+ }
+ },
+ "NETWORK_VERSION_TOO_OLD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "network_version_too_old"
+ }
+ },
+ "UNPROCESSED_NETWORK_TASK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unprocessed_network_task"
+ }
+ },
+ "UNRETRIEVABLE_DOCUMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unretrievable_document"
+ }
+ },
+ "UNRETRIEVABLE_ERROR_CODE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unretrievable_error_code"
+ }
+ },
+ "UNSUPPORTED_MEDIA_TYPE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unsupported_media_type"
+ }
+ },
+ "INVALID_S3_SNAPSHOT_REQUEST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_s3_snapshot_request"
+ }
+ },
+ "INVALID_S3_SNAPSHOT_PARAMETERS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_s3_snapshot_parameters"
+ }
+ },
+ "S3_SNAPSHOT_SERVER_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "s3_snapshot_server_error"
+ }
+ },
+ "VECTOR_EMBEDDING_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "vector_embedding_error"
+ }
+ },
+ "NOT_FOUND_SIMILAR_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "not_found_similar_id"
+ }
+ },
+ "INVALID_DOCUMENT_EDITION_CONTEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_edition_context"
+ }
+ },
+ "INVALID_DOCUMENT_EDITION_FUNCTION_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_document_edition_function_filter"
+ }
+ },
+ "EDIT_DOCUMENTS_BY_FUNCTION_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "edit_documents_by_function_error"
+ }
+ },
+ "INVALID_SETTINGS_INDEX_CHAT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_settings_index_chat"
+ }
+ },
+ "INVALID_EXPORT_URL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_url"
+ }
+ },
+ "INVALID_EXPORT_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_api_key"
+ }
+ },
+ "INVALID_EXPORT_PAYLOAD_SIZE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_payload_size"
+ }
+ },
+ "INVALID_EXPORT_INDEXES_PATTERNS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_indexes_patterns"
+ }
+ },
+ "INVALID_EXPORT_INDEX_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_index_filter"
+ }
+ },
+ "INVALID_EXPORT_INDEX_OVERRIDE_SETTINGS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_export_index_override_settings"
+ }
+ },
+ "UNIMPLEMENTED_EXTERNAL_FUNCTION_CALLING": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unimplemented_external_function_calling"
+ }
+ },
+ "UNIMPLEMENTED_NON_STREAMING_CHAT_COMPLETIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unimplemented_non_streaming_chat_completions"
+ }
+ },
+ "UNIMPLEMENTED_MULTI_CHOICE_CHAT_COMPLETIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "unimplemented_multi_choice_chat_completions"
+ }
+ },
+ "CHAT_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chat_not_found"
+ }
+ },
+ "INVALID_CHAT_SETTING_DOCUMENT_TEMPLATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_setting_document_template"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_ORG_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_org_id"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_PROJECT_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_project_id"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_API_VERSION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_api_version"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_DEPLOYMENT_ID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_deployment_id"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SOURCE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_source"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_BASE_API": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_base_api"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_API_KEY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_api_key"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_PROMPTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_prompts"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SYSTEM_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_system_prompt"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SEARCH_DESCRIPTION_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_search_description_prompt"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SEARCH_QUERY_PARAM_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_search_query_param_prompt"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SEARCH_FILTER_PARAM_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_search_filter_param_prompt"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_SEARCH_INDEX_UID_PARAM_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_search_index_uid_param_prompt"
+ }
+ },
+ "INVALID_CHAT_COMPLETION_PRE_QUERY_PROMPT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_chat_completion_pre_query_prompt"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_ATTRIBUTE_PATTERNS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_attribute_patterns"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_DISPLAYED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_displayed"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_SEARCHABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_searchable"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_SORTABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_sortable"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_DISTINCT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_distinct"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_RANKING_RULE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_ranking_rule"
+ }
+ },
+ "INVALID_INDEX_FIELDS_FILTER_FILTERABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_index_fields_filter_filterable"
+ }
+ },
+ "REQUIRES_ENTERPRISE_EDITION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "requires_enterprise_edition"
+ }
+ },
+ "INVALID_RENDER_TEMPLATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_render_template"
+ }
+ },
+ "INVALID_RENDER_INPUT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_render_input"
+ }
+ },
+ "RENDER_DOCUMENT_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "render_document_not_found"
+ }
+ },
+ "TEMPLATE_PARSING_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "template_parsing_error"
+ }
+ },
+ "TEMPLATE_RENDERING_ERROR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "template_rendering_error"
+ }
+ },
+ "INVALID_WEBHOOKS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_webhooks"
+ }
+ },
+ "INVALID_WEBHOOK_URL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_webhook_url"
+ }
+ },
+ "INVALID_WEBHOOK_HEADERS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_webhook_headers"
+ }
+ },
+ "IMMUTABLE_WEBHOOK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_webhook"
+ }
+ },
+ "INVALID_WEBHOOK_UUID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_webhook_uuid"
+ }
+ },
+ "WEBHOOK_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhook_not_found"
+ }
+ },
+ "IMMUTABLE_WEBHOOK_UUID": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_webhook_uuid"
+ }
+ },
+ "IMMUTABLE_WEBHOOK_IS_EDITABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "immutable_webhook_is_editable"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_OFFSET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_offset"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_LIMIT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_limit"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_FILTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_filter"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_DESCRIPTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_description"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_PRIORITY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_priority"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_ACTIVE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_active"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_CONDITIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_conditions"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_ACTIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_actions"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_FILTER_QUERY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_filter_query"
+ }
+ },
+ "INVALID_DYNAMIC_SEARCH_RULE_FILTER_ACTIVE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_dynamic_search_rule_filter_active"
+ }
+ },
+ "DYNAMIC_SEARCH_RULE_NOT_FOUND": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamic_search_rule_not_found"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ErrorType": {
+ "type": "enum",
+ "members": {
+ "INTERNAL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "internal"
+ }
+ },
+ "INVALID_REQUEST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "invalid_request"
+ }
+ },
+ "AUTH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "auth"
+ }
+ },
+ "SYSTEM": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "system"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FacetSearchResultRemoteErrorsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ResponseError"
+ },
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Only present in federated search when some remotes failed."
+ }
+ },
+ "com.meilisearch.api#Search": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SearchRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#FacetSearchResult"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/facet-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Search for facet values\n\nSearch for facet values matching a query within a given facet attribute. Use this to build\nautocomplete or dropdown UIs for facet filters.\n\n**Prerequisite:** The `facetName` attribute must be in the index's `filterableAttributes` list.\nFacet search will not work without this configuration.\n\n**Note:** Facet search only considers the first word of `facetQuery`. Searching for `Jane`\nreturns `Jane Austen`, but searching for `Austen` does not.\n\n**Note:** Numeric facet values are not searchable. Convert numbers to strings if you need\nto search them as facets."
+ }
+ },
+ "com.meilisearch.api#ListFieldsFilter": {
+ "type": "structure",
+ "members": {
+ "attributePatterns": {
+ "target": "com.meilisearch.api#AttributePatterns",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "displayed": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that are displayed (true) or not displayed (false) in search results.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that are searchable (true) or not searchable (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sortable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that are sortable (true) or not sortable (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that are used as distinct attribute (true) or not (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingRule": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that have a custom ranking rule (asc/desc) (true) or not (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filterable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Only include fields that are filterable (true) or not filterable (false).",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Filter fields by attribute name patterns or by capability (displayed, searchable, sortable, etc.). All criteria are ANDed."
+ }
+ },
+ "com.meilisearch.api#AttributePatterns": {
+ "type": "structure",
+ "members": {
+ "patterns": {
+ "target": "com.meilisearch.api#AttributePatternsPatternsList",
+ "traits": {
+ "smithy.api#documentation": "An array of attribute name patterns. Each pattern can be an exact\nattribute name, or include wildcards (`*`) at the start, end, or\nboth. Examples: `[\"title\", \"description_*\", \"*_date\", \"*content*\"]`.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A collection of patterns used to match attribute names. Patterns can\ninclude wildcards (`*`) for flexible matching. For example, `title`\nmatches exactly, `overview_*` matches any attribute starting with\n`overview_`, and `*_date` matches any attribute ending with `_date`."
+ }
+ },
+ "com.meilisearch.api#AttributePatternsPatternsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of attribute name patterns. Each pattern can be an exact\nattribute name, or include wildcards (`*`) at the start, end, or\nboth. Examples: `[\"title\", \"description_*\", \"*_date\", \"*content*\"]`."
+ }
+ },
+ "com.meilisearch.api#PostIndexFieldsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index whose fields to list."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of fields to skip. Defaults to 0."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of fields to return. Defaults to 20."
+ }
+ },
+ "filter": {
+ "target": "com.meilisearch.api#ListFieldsFilter",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PaginationViewField": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#PaginationViewFieldResultsList",
+ "traits": {
+ "smithy.api#documentation": "Items for the current page.",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of items skipped.",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of items returned.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of items matching the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldDisplayConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldSearchConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldSortableConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldDistinctConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldRankingRuleConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "order": {
+ "target": "com.meilisearch.api#FieldRankingRuleConfigOrderList"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldRankingRuleConfigOrderList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldFilterableConfig": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "sortBy": {
+ "target": "com.meilisearch.api#FacetValuesSort",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "facetSearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "equality": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "comparison": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FacetValuesSort": {
+ "type": "enum",
+ "members": {
+ "ALPHA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "alpha"
+ }
+ },
+ "COUNT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "count"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldLocalizedConfig": {
+ "type": "structure",
+ "members": {
+ "locales": {
+ "target": "com.meilisearch.api#FieldLocalizedConfigLocalesList",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FieldLocalizedConfigLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewFieldResultsItem": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "displayed": {
+ "target": "com.meilisearch.api#FieldDisplayConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "searchable": {
+ "target": "com.meilisearch.api#FieldSearchConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "sortable": {
+ "target": "com.meilisearch.api#FieldSortableConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "distinct": {
+ "target": "com.meilisearch.api#FieldDistinctConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "rankingRule": {
+ "target": "com.meilisearch.api#FieldRankingRuleConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "filterable": {
+ "target": "com.meilisearch.api#FieldFilterableConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "localized": {
+ "target": "com.meilisearch.api#FieldLocalizedConfig",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewFieldResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#PaginationViewFieldResultsItem"
+ },
+ "traits": {
+ "smithy.api#documentation": "Items for the current page."
+ }
+ },
+ "com.meilisearch.api#PostIndexFields": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PostIndexFieldsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewField"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/fields",
+ "code": 200
+ },
+ "smithy.api#documentation": "List index fields\n\nReturns a paginated list of fields in the index with their metadata: whether they are displayed, searchable, sortable, filterable, distinct, have a custom ranking rule (asc/desc), and for filterable fields the sort order for facet values."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToRetrieveList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToCropList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToHighlightList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestFacetsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToSearchOnList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Locale"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequestVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchWithUrlQueryRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "q": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "q",
+ "smithy.api#documentation": "Sets the search terms.\n\nMeilisearch returns documents that match this query.\n\nThe query supports [prefix search](https://www.meilisearch.com/docs/learn/engine/prefix) and [typo tolerance](https://www.meilisearch.com/docs/learn/relevancy/typo_tolerance_settings).\n\nMeilisearch only considers the first ten words; terms are normalized (lowercase, accents ignored).\n\nOmit or leave empty for a placeholder search: no query terms are applied, so Meilisearch returns all searchable documents in the index, ordered by [ranking rules](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules).\n\nEnclose terms in double quotes (`\"`) for phrase search: only documents containing that exact sequence of words are returned (e.g. `\"Winter Feast\"`).\n\nUse a minus sign (`-`) before a word or phrase to exclude it from results."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "offset",
+ "smithy.api#documentation": "Number of documents to skip at the start of the results.\n\nUse together with `limit` for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination) (e.g. offset=20 and limit=20 returns results 21–40).\n\nThis parameter is ignored when `page` or `hitsPerPage` is set; in that case the response includes `totalHits` and `totalPages` instead of `estimatedTotalHits`."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of documents to return in the response.\n\nUse with `offset` for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination).\n\nThis parameter is ignored when `page` or `hitsPerPage` is set.\n\nThe value cannot exceed the index [maxTotalHits](https://www.meilisearch.com/docs/reference/api/settings/update-pagination#body-max-total-hits-one-of-0) setting."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "page",
+ "smithy.api#documentation": "Request a specific results page (1-indexed).\n\nUse together with `hitsPerPage`.\n\nWhen this parameter is set, the response includes `totalHits` and `totalPages` instead of `estimatedTotalHits`.\n\n`page` and `hitsPerPage` take precedence over `offset` and `limit`."
+ }
+ },
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "hitsPerPage",
+ "smithy.api#documentation": "Maximum number of documents per page for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination).\n\nThis value determines `totalPages`; use it together with `page`.\n\nWhen set, the response includes `totalHits` and `totalPages`.\n\nSet to 0 to obtain the exhaustive `totalHits` count without returning any documents."
+ }
+ },
+ "attributesToRetrieve": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToRetrieveList",
+ "traits": {
+ "smithy.api#httpQuery": "attributesToRetrieve",
+ "smithy.api#documentation": "List of attributes to include in each returned document.\n\nUse `[\"*\"]` to return all attributes; if not set, the index [displayed attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list is used.\n\nAttributes that are not in [displayedAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-displayed-attributes-one-of-0) are omitted from the response."
+ }
+ },
+ "attributesToCrop": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToCropList",
+ "traits": {
+ "smithy.api#httpQuery": "attributesToCrop",
+ "smithy.api#documentation": "Attributes whose values should be cropped to a short excerpt.\n\nThe cropped text appears in each hit's `_formatted` object.\n\nLength is controlled by `cropLength`, or you can override it per attribute with the `attribute:length` syntax.\n\nUse `[\"*\"]` to crop all attributes in `attributesToRetrieve`.\n\nWhen possible, the crop is centered around the matching terms."
+ }
+ },
+ "cropLength": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "cropLength",
+ "smithy.api#documentation": "Maximum number of words to include in cropped values.\n\nThis parameter only applies when `attributesToCrop` is set.\n\nBoth query terms and [stop words](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-stop-words-one-of-0) count toward this length."
+ }
+ },
+ "cropMarker": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "cropMarker",
+ "smithy.api#documentation": "String used to mark crop boundaries in cropped text.\n\nIf null or empty, no markers are inserted.\n\nMarkers are only added where content was actually removed."
+ }
+ },
+ "attributesToHighlight": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToHighlightList",
+ "traits": {
+ "smithy.api#httpQuery": "attributesToHighlight",
+ "smithy.api#documentation": "Attributes in which matching query terms should be highlighted.\n\nThe highlighted text appears in each hit's `_formatted` object.\n\nUse `[\"*\"]` to highlight in all attributes from `attributesToRetrieve`.\n\nBy default, matches are wrapped in `` and ``; you can override this with `highlightPreTag` and `highlightPostTag`.\n\nHighlighting also applies to [synonyms](https://www.meilisearch.com/docs/learn/relevancy/synonyms) and [stop words](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-stop-words-one-of-0).\n\nSupported value types are string, number, array, and object.\n\nNote: highlights matches within all listed attributes, even those not in `searchableAttributes`."
+ }
+ },
+ "highlightPreTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "highlightPreTag",
+ "smithy.api#documentation": "String to insert before each highlighted term.\n\nCan be any string (e.g. ``, `*`).\n\nIf null or empty, nothing is inserted at the start of a match."
+ }
+ },
+ "highlightPostTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "highlightPostTag",
+ "smithy.api#documentation": "String to insert after each highlighted term.\n\nShould be used together with `highlightPreTag` to avoid malformed output (e.g. unclosed HTML tags)."
+ }
+ },
+ "showMatchesPosition": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showMatchesPosition",
+ "smithy.api#documentation": "When true, each hit includes a `_matchesPosition` object with the byte offset (`start` and `length`) of each matched term.\n\nThis is useful when you need custom highlighting.\n\nNote: reports match positions in all attributes, even non-searchable ones. Positions are measured in bytes, not characters."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "filter",
+ "smithy.api#documentation": "A [filter](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results) expression to narrow results.\n\nAll attributes used in the expression must be in [filterableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-filterable-attributes-one-of-0).\n\nPass a string (e.g. `\"(genres = horror OR genres = mystery) AND director = 'Jordan Peele'\"`).\n\nFor [geo search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/geosearch), use `_geoRadius(lat, lng, distance_in_meters)`, `_geoBoundingBox([lat,lng],[lat,lng])`, or `_geoPolygon([lat,lng], ...)` (GeoJSON only for polygon).\n\nGET route accepts a string only; the value must be URL-encoded."
+ }
+ },
+ "sort": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "sort",
+ "smithy.api#documentation": "Sort results by one or more attributes and their order.\n\nUse the format `[\"attribute:asc\", \"attribute:desc\"]`; only attributes in [sortableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-sortable-attributes-one-of-0) can be used.\n\nFor [geo search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/geosearch), use `_geoPoint(lat,lng):asc` or `:desc`; the response then includes `_geoDistance` in meters.\n\nThe first attribute in the list has precedence.\n\nSee [sorting search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results)."
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "distinct",
+ "smithy.api#documentation": "Return only one document per distinct value of the given attribute (e.g. deduplicate by product_id).\n\nThe attribute must be in [filterableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-filterable-attributes-one-of-0).\n\nThis overrides the index [distinctAttribute](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-distinct-attribute-one-of-0) setting for this request.\n\nSee [distinct attribute](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute)."
+ }
+ },
+ "facets": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestFacetsList",
+ "traits": {
+ "smithy.api#httpQuery": "facets",
+ "smithy.api#documentation": "Return the count of matches per facet value for the listed attributes.\n\nThe response includes `facetDistribution` and, for numeric facets, `facetStats` (min/max).\n\nThis route also supports patterns, i.e., \"title\", \"dogs.*\", \"*\", which can match over the [filterableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-filterable-attributes-one-of-0).\n\nThe number of values returned per facet is limited by the index [maxValuesPerFacet](https://www.meilisearch.com/docs/reference/api/settings/update-faceting#body-max-values-per-facet-one-of-0) setting; attributes not in filterableAttributes are ignored.\n\nMore info: [faceting](https://www.meilisearch.com/docs/learn/filtering_and_sorting/search_with_facet_filters)."
+ }
+ },
+ "matchingStrategy": {
+ "target": "com.meilisearch.api#MatchingStrategy",
+ "traits": {
+ "smithy.api#httpQuery": "matchingStrategy",
+ "smithy.api#documentation": "How to match query terms when there are not enough results to satisfy `limit`.\n\n**`last`**: Returns documents containing all query terms first. If there are not enough such results, Meilisearch removes one query term at a time, starting from the end of the query (e.g. for \"big fat cat\", then \"big fat\", then \"big\").\n\n**`all`**: Only returns documents that contain all query terms. Meilisearch does not relax the query even if fewer than `limit` documents match.\n\n**`frequency`**: Returns documents containing all query terms first. If there are not enough, removes one term at a time starting with the word that is most frequent in the dataset, giving more weight to rarer terms (e.g. in \"white cotton shirt\", prioritizes documents containing \"white\" if \"shirt\" is very common).\n\nDefault: `last`."
+ }
+ },
+ "attributesToSearchOn": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestAttributesToSearchOnList",
+ "traits": {
+ "smithy.api#httpQuery": "attributesToSearchOn",
+ "smithy.api#documentation": "Restrict the search to the listed attributes only.\n\nEach attribute must be in the index [searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list.\n\nThe order of attributes in this parameter does not affect relevancy."
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#httpQuery": "rankingScoreThreshold",
+ "smithy.api#documentation": "Exclude from the results any document whose [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) is below this value (between 0.0 and 1.0).\n\nExcluded hits do not count toward `estimatedTotalHits`, `totalHits`, or facet distribution.\n\nWhen used together with `page` and `hitsPerPage`, this parameter may reduce performance because Meilisearch must score all matching documents."
+ }
+ },
+ "locales": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestLocalesList",
+ "traits": {
+ "smithy.api#httpQuery": "locales",
+ "smithy.api#documentation": "Explicitly specify the language(s) of the query.\n\nPass an array of [supported ISO-639 locales](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-localized-attributes-one-of-0).\n\nThis overrides auto-detection; use it when auto-detection is wrong for the query or the documents.\n\nSee also the [localizedAttributes](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#response-localized-attributes-one-of-0) settings and [Language](https://www.meilisearch.com/docs/learn/resources/language)."
+ }
+ },
+ "hybridEmbedder": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "hybridEmbedder",
+ "smithy.api#documentation": "Name of the embedder for [hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search), which combines keyword and semantic search.\n\nMust match an embedder configured in the index settings.\n\nRequired when `vector` or `hybridSemanticRatio` is set."
+ }
+ },
+ "hybridSemanticRatio": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#httpQuery": "hybridSemanticRatio",
+ "smithy.api#documentation": "Balance between keyword and semantic search: 0.0 means keyword-only results, 1.0 means semantic-only.\n\nWhen `q` is empty and this value is greater than 0, Meilisearch performs a pure semantic search.\n\nRequires `hybridEmbedder` when set."
+ }
+ },
+ "vector": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequestVectorList",
+ "traits": {
+ "smithy.api#httpQuery": "vector",
+ "smithy.api#documentation": "Custom query vector for [vector or hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search).\n\nThe array length must match the dimensions of the embedder configured in the index.\n\nThis parameter is mandatory when using a [user-provided embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/search_with_user_provided_embeddings).\n\nWhen used with `hybrid`, documents are ranked by vector similarity.\n\nYou can also use it to override an embedder's automatic vector generation."
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "retrieveVectors",
+ "smithy.api#documentation": "When true, the response includes document and query embeddings in each hit's `_vectors` field.\n\nThe `_vectors` field must be listed in [displayedAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-displayed-attributes-one-of-0) for it to appear."
+ }
+ },
+ "personalizeUserContext": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "personalizeUserContext",
+ "smithy.api#documentation": "For [personalized search](https://www.meilisearch.com/docs/learn/personalization/making_personalized_search_queries): a string describing the user (e.g. preferences or behavior).\n\nResults are then tailored to that profile.\n\nPersonalization must be [enabled](https://www.meilisearch.com/docs/reference/api/experimental-features/configure-experimental-features) (e.g. Cohere key for self-hosted instances)."
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "useNetwork",
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered, documents deduplicated across remotes).\n\nWhen `false` or omitted, the query runs locally.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` or omitted = local (default).\n\nWhen using the network, the index must exist with compatible settings on all remotes.\n\nDocuments with the same id are assumed identical for deduplication."
+ }
+ },
+ "showRankingScore": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showRankingScore",
+ "smithy.api#documentation": "When true, each document includes a `_rankingScore` between 0.0 and 1.0; a higher value means the document is more relevant.\n\nSee [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score).\n\nThe `sort` ranking rule does not affect the value of `_rankingScore`."
+ }
+ },
+ "showRankingScoreDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showRankingScoreDetails",
+ "smithy.api#documentation": "When true, each document includes `_rankingScoreDetails`, which breaks down the score contribution of each [ranking rule](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules).\n\nUseful for debugging relevancy."
+ }
+ },
+ "showPerformanceDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showPerformanceDetails",
+ "smithy.api#documentation": "When true, the response includes a `performanceDetails` object with a timing breakdown of the query processing."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SearchHit": {
+ "type": "structure",
+ "members": {
+ "_formatted": {
+ "target": "com.meilisearch.api#SearchHitFormattedMap",
+ "traits": {
+ "smithy.api#documentation": "Document with highlighted and cropped attributes.\n\nPresent when `attributesToHighlight` or `attributesToCrop` was set."
+ }
+ },
+ "_matchesPosition": {
+ "target": "com.meilisearch.api#SearchHitMatchesPositionMap",
+ "traits": {
+ "smithy.api#documentation": "Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "_rankingScore": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Global [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) from 0.0 to 1.0.\n\nPresent when `showRankingScore` was true.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "_rankingScoreDetails": {
+ "target": "com.meilisearch.api#SearchHitRankingScoreDetailsMap",
+ "traits": {
+ "smithy.api#documentation": "Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A single search result hit."
+ }
+ },
+ "com.meilisearch.api#SearchHitFormattedMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Document with highlighted and cropped attributes.\n\nPresent when `attributesToHighlight` or `attributesToCrop` was set."
+ }
+ },
+ "com.meilisearch.api#MatchBounds": {
+ "type": "structure",
+ "members": {
+ "start": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The byte offset where the match begins within the attribute value.\nThis is a zero-indexed position from the start of the string.",
+ "smithy.api#required": {}
+ }
+ },
+ "length": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The length in bytes of the matched text. Combined with `start`, this\ndefines the exact substring that matched the query term.",
+ "smithy.api#required": {}
+ }
+ },
+ "indices": {
+ "target": "com.meilisearch.api#MatchBoundsIndicesList",
+ "traits": {
+ "smithy.api#documentation": "Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents the position of a matching term in a document field. Used to\nindicate where query terms were found within attribute values, enabling\nfeatures like highlighting and match position display."
+ }
+ },
+ "com.meilisearch.api#MatchBoundsIndicesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches."
+ }
+ },
+ "com.meilisearch.api#SearchHitMatchesPositionValueList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#MatchBounds"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SearchHitMatchesPositionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#SearchHitMatchesPositionValueList"
+ },
+ "traits": {
+ "smithy.api#documentation": "Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true."
+ }
+ },
+ "com.meilisearch.api#SearchHitRankingScoreDetailsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponseHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchHit"
+ },
+ "traits": {
+ "smithy.api#documentation": "Matching documents.\n\nEach hit contains document fields and, when requested, `_formatted`, `_matchesPosition`, `_rankingScore`, `_rankingScoreDetails`, `_geoDistance`."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponseQueryVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {
+ "smithy.api#documentation": "Query embedding used for the search.\n\nPresent when vector or hybrid search was used."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponseFacetDistributionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of matching documents per facet value for each requested facet.\n\nPresent when `facets` was set."
+ }
+ },
+ "com.meilisearch.api#FacetStats": {
+ "type": "structure",
+ "members": {
+ "min": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Lowest numeric value for this facet among matching documents.",
+ "smithy.api#required": {}
+ }
+ },
+ "max": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Highest numeric value for this facet among matching documents.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponseFacetStatsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetStats"
+ },
+ "traits": {
+ "smithy.api#documentation": "Minimum and maximum numeric values per facet.\n\nPresent for numeric facets when `facets` was set."
+ }
+ },
+ "com.meilisearch.api#SearchMetadata": {
+ "type": "structure",
+ "members": {
+ "query": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "queryUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for the query.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "UID of the index that was searched.",
+ "smithy.api#required": {}
+ }
+ },
+ "primaryKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "remote": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Remote that processed the query (federated search only).",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Metadata about a search query (included when requested via header)."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponseRemoteErrorsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ResponseError"
+ },
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Federated search only."
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQueryResponse": {
+ "type": "structure",
+ "members": {
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results per page."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Current page index (1-based)."
+ }
+ },
+ "totalPages": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of result pages."
+ }
+ },
+ "totalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of matching documents."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents skipped."
+ }
+ },
+ "estimatedTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance."
+ }
+ },
+ "hits": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponseHitsList",
+ "traits": {
+ "smithy.api#documentation": "Matching documents.\n\nEach hit contains document fields and, when requested, `_formatted`, `_matchesPosition`, `_rankingScore`, `_rankingScoreDetails`, `_geoDistance`.",
+ "smithy.api#required": {}
+ }
+ },
+ "query": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string that produced this response.",
+ "smithy.api#required": {}
+ }
+ },
+ "queryVector": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponseQueryVectorList",
+ "traits": {
+ "smithy.api#documentation": "Query embedding used for the search.\n\nPresent when vector or hybrid search was used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Time taken to process the query, in milliseconds.",
+ "smithy.api#required": {}
+ }
+ },
+ "facetDistribution": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponseFacetDistributionMap",
+ "traits": {
+ "smithy.api#documentation": "Count of matching documents per facet value for each requested facet.\n\nPresent when `facets` was set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetStats": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponseFacetStatsMap",
+ "traits": {
+ "smithy.api#documentation": "Minimum and maximum numeric values per facet.\n\nPresent for numeric facets when `facets` was set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "requestUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "UUID v7 identifying this search request.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "metadata": {
+ "target": "com.meilisearch.api#SearchMetadata",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "performanceDetails": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Timing breakdown per processing step.\n\nPresent when `showPerformanceDetails` was true."
+ }
+ },
+ "remoteErrors": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponseRemoteErrorsMap",
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Federated search only.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "semanticHitCount": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive number of semantic search matches.\n\nAI-powered (hybrid/semantic) searches only.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#SearchWithUrlQuery": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SearchWithUrlQueryResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Search with GET\n\nSearch for documents matching a query in the given index.\n\n> Equivalent to the [search with POST route](/docs/reference/api/search/search-with-post) in the Meilisearch API.\n\n**Note:** By default this endpoint returns at most 1000 results. Configure `pagination.maxTotalHits` in index settings to change this limit.\n\n**Note:** The GET route only accepts string filter expressions. Use the POST route if you need array-of-array filter syntax."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestAttributesToRetrieveList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "List of attributes to include in each returned document.\n\nUse `[\"*\"]` to return all attributes; if not set, the index [displayed attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list is used.\n\nAttributes that are not in [displayedAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-displayed-attributes-one-of-0) are omitted from the response."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestAttributesToCropList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes whose values should be cropped to a short excerpt.\n\nThe cropped text appears in each hit's `_formatted` object.\n\nLength is controlled by `cropLength`, or you can override it per attribute with the `attribute:length` syntax.\n\nUse `[\"*\"]` to crop all attributes in `attributesToRetrieve`.\n\nWhen possible, the crop is centered around the matching terms."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestAttributesToHighlightList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes in which matching query terms should be highlighted.\n\nThe highlighted text appears in each hit's `_formatted` object.\n\nUse `[\"*\"]` to highlight in all attributes from `attributesToRetrieve`.\n\nBy default, matches are wrapped in `` and ``; you can override this with `highlightPreTag` and `highlightPostTag`.\n\nHighlighting also applies to [synonyms](https://www.meilisearch.com/docs/learn/relevancy/synonyms) and [stop words](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-stop-words-one-of-0).\n\nSupported value types are string, number, array, and object.\n\nNote: highlights matches within all listed attributes, even those not in `searchableAttributes`."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestSortList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Sort results by one or more attributes and their order.\n\nUse the format `[\"attribute:asc\", \"attribute:desc\"]`; only attributes in [sortableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-sortable-attributes-one-of-0) can be used.\n\nFor [geo search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/geosearch), use `_geoPoint(lat,lng):asc` or `:desc`; the response then includes `_geoDistance` in meters.\n\nThe first attribute in the list has precedence.\n\nSee [sorting search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results)."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestAttributesToSearchOnList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Restrict the search to the listed attributes only.\n\nEach attribute must be in the index [searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list.\n\nThe order of attributes in this parameter does not affect relevancy."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Locale"
+ },
+ "traits": {
+ "smithy.api#documentation": "Explicitly specify the language(s) of the query.\n\nPass an array of [supported ISO-639 locales](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-localized-attributes-one-of-0).\n\nThis overrides auto-detection; use it when auto-detection is wrong for the query or the documents.\n\nSee also the [localizedAttributes](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#response-localized-attributes-one-of-0) settings and [Language](https://www.meilisearch.com/docs/learn/resources/language)."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequestVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {
+ "smithy.api#documentation": "Custom query vector for [vector or hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search).\n\nThe array length must match the dimensions of the embedder configured in the index.\n\nThis parameter is mandatory when using a [user-provided embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/search_with_user_provided_embeddings).\n\nWhen used with `hybrid`, documents are ranked by vector similarity.\n\nYou can also use it to override an embedder's automatic vector generation."
+ }
+ },
+ "com.meilisearch.api#Personalize": {
+ "type": "structure",
+ "members": {
+ "userContext": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String describing the user (e.g. preferences, behavior).\n\nUsed to return different results for different profiles.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Configuration for [personalized search](https://www.meilisearch.com/docs/learn/personalization/making_personalized_search_queries) results.\n\nWhen enabled, results are tailored to the user profile described in `userContext`."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "q": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Sets the search terms.\n\nMeilisearch returns documents that match this query.\n\nThe query supports [prefix search](https://www.meilisearch.com/docs/learn/engine/prefix) and [typo tolerance](https://www.meilisearch.com/docs/learn/relevancy/typo_tolerance_settings).\n\nMeilisearch only considers the first ten words; terms are normalized (lowercase, accents ignored).\n\nOmit or leave empty for a placeholder search: no query terms are applied, so Meilisearch returns all searchable documents in the index, ordered by [ranking rules](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules).\n\nEnclose terms in double quotes (`\"`) for phrase search: only documents containing that exact sequence of words are returned (e.g. `\"Winter Feast\"`).\n\nUse a minus sign (`-`) before a word or phrase to exclude it from results.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents to skip at the start of the results.\n\nUse together with `limit` for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination) (e.g. offset=20 and limit=20 returns results 21–40).\n\nThis parameter is ignored when `page` or `hitsPerPage` is set; in that case the response includes `totalHits` and `totalPages` instead of `estimatedTotalHits`."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents to return in the response.\n\nUse with `offset` for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination).\n\nThis parameter is ignored when `page` or `hitsPerPage` is set. The value cannot exceed the index [maxTotalHits](https://www.meilisearch.com/docs/reference/api/settings/update-pagination#body-max-total-hits-one-of-0) setting."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Request a specific results page (1-indexed).\n\nUse together with `hitsPerPage`.\n\nWhen this parameter is set, the response includes `totalHits` and `totalPages` instead of `estimatedTotalHits`.\n\n`page` and `hitsPerPage` take precedence over `offset` and `limit`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents per page for [pagination](https://www.meilisearch.com/docs/guides/front_end/pagination).\n\nThis value determines `totalPages`; use it together with `page`.\n\nWhen set, the response includes `totalHits` and `totalPages`.\n\nSet to 0 to obtain the exhaustive `totalHits` count without returning any documents.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "attributesToRetrieve": {
+ "target": "com.meilisearch.api#SearchWithPostRequestAttributesToRetrieveList",
+ "traits": {
+ "smithy.api#documentation": "List of attributes to include in each returned document.\n\nUse `[\"*\"]` to return all attributes; if not set, the index [displayed attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list is used.\n\nAttributes that are not in [displayedAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-displayed-attributes-one-of-0) are omitted from the response.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "attributesToCrop": {
+ "target": "com.meilisearch.api#SearchWithPostRequestAttributesToCropList",
+ "traits": {
+ "smithy.api#documentation": "Attributes whose values should be cropped to a short excerpt.\n\nThe cropped text appears in each hit's `_formatted` object.\n\nLength is controlled by `cropLength`, or you can override it per attribute with the `attribute:length` syntax.\n\nUse `[\"*\"]` to crop all attributes in `attributesToRetrieve`.\n\nWhen possible, the crop is centered around the matching terms.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "cropLength": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of words to include in cropped values.\n\nThis parameter only applies when `attributesToCrop` is set.\n\nBoth query terms and [stop words](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-stop-words-one-of-0) count toward this length."
+ }
+ },
+ "cropMarker": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String used to mark crop boundaries in cropped text.\n\nIf null or empty, no markers are inserted.\n\nMarkers are only added where content was actually removed."
+ }
+ },
+ "attributesToHighlight": {
+ "target": "com.meilisearch.api#SearchWithPostRequestAttributesToHighlightList",
+ "traits": {
+ "smithy.api#documentation": "Attributes in which matching query terms should be highlighted.\n\nThe highlighted text appears in each hit's `_formatted` object.\n\nUse `[\"*\"]` to highlight in all attributes from `attributesToRetrieve`.\n\nBy default, matches are wrapped in `` and ``; you can override this with `highlightPreTag` and `highlightPostTag`.\n\nHighlighting also applies to [synonyms](https://www.meilisearch.com/docs/learn/relevancy/synonyms) and [stop words](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-stop-words-one-of-0).\n\nSupported value types are string, number, array, and object.\n\nNote: highlights matches within all listed attributes, even those not in `searchableAttributes`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "highlightPreTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String to insert before each highlighted term.\n\nCan be any string (e.g. ``, `*`).\n\nIf null or empty, nothing is inserted at the start of a match."
+ }
+ },
+ "highlightPostTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String to insert after each highlighted term.\n\nShould be used together with `highlightPreTag` to avoid malformed output (e.g. unclosed HTML tags)."
+ }
+ },
+ "showMatchesPosition": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, each hit includes a `_matchesPosition` object with the byte offset (`start` and `length`) of each matched term.\n\nThis is useful when you need custom highlighting.\n\nNote: reports match positions in all attributes, even non-searchable ones. Positions are measured in bytes, not characters."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "A [filter](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results) expression to narrow results.\n\nAll attributes used in the expression must be in [filterableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-filterable-attributes-one-of-0).\n\nYou can pass a string (e.g. `\"(genres = horror OR genres = mystery) AND director = 'Jordan Peele'\"`) or an array (e.g. `[[\"genres = horror\", \"genres = mystery\"], \"director = 'Jordan Peele'\"]`).\n\nFor [geo search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/geosearch), use `_geoRadius(lat, lng, distance_in_meters)`, `_geoBoundingBox([lat,lng],[lat,lng])`, or `_geoPolygon([lat,lng], ...)` (GeoJSON only for polygon)."
+ }
+ },
+ "sort": {
+ "target": "com.meilisearch.api#SearchWithPostRequestSortList",
+ "traits": {
+ "smithy.api#documentation": "Sort results by one or more attributes and their order.\n\nUse the format `[\"attribute:asc\", \"attribute:desc\"]`; only attributes in [sortableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-sortable-attributes-one-of-0) can be used.\n\nFor [geo search](https://www.meilisearch.com/docs/learn/filtering_and_sorting/geosearch), use `_geoPoint(lat,lng):asc` or `:desc`; the response then includes `_geoDistance` in meters.\n\nThe first attribute in the list has precedence.\n\nSee [sorting search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Return only one document per distinct value of the given attribute (e.g. deduplicate by product_id).\n\nThe attribute must be in [filterableAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-filterable-attributes-one-of-0).\n\nThis overrides the index [distinctAttribute](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-distinct-attribute-one-of-0) setting for this request.\n\nSee [distinct attribute](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facets": {
+ "target": "com.meilisearch.api#AttributePatterns",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "matchingStrategy": {
+ "target": "com.meilisearch.api#MatchingStrategy"
+ },
+ "attributesToSearchOn": {
+ "target": "com.meilisearch.api#SearchWithPostRequestAttributesToSearchOnList",
+ "traits": {
+ "smithy.api#documentation": "Restrict the search to the listed attributes only.\n\nEach attribute must be in the index [searchable attributes](https://www.meilisearch.com/docs/learn/relevancy/displayed_searchable_attributes) list.\n\nThe order of attributes in this parameter does not affect relevancy.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Exclude from the results any document whose [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) is below this value (between 0.0 and 1.0).\n\nExcluded hits do not count toward `estimatedTotalHits`, `totalHits`, or facet distribution.\n\nWhen used together with `page` and `hitsPerPage`, this parameter may reduce performance because Meilisearch must score all matching documents.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "locales": {
+ "target": "com.meilisearch.api#SearchWithPostRequestLocalesList",
+ "traits": {
+ "smithy.api#documentation": "Explicitly specify the language(s) of the query.\n\nPass an array of [supported ISO-639 locales](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-localized-attributes-one-of-0).\n\nThis overrides auto-detection; use it when auto-detection is wrong for the query or the documents.\n\nSee also the [localizedAttributes](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#response-localized-attributes-one-of-0) settings and [Language](https://www.meilisearch.com/docs/learn/resources/language).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "hybrid": {
+ "target": "com.meilisearch.api#HybridQuery",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "vector": {
+ "target": "com.meilisearch.api#SearchWithPostRequestVectorList",
+ "traits": {
+ "smithy.api#documentation": "Custom query vector for [vector or hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search).\n\nThe array length must match the dimensions of the embedder configured in the index.\n\nThis parameter is mandatory when using a [user-provided embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/search_with_user_provided_embeddings).\n\nWhen used with `hybrid`, documents are ranked by vector similarity.\n\nYou can also use it to override an embedder's automatic vector generation.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, the response includes document and query embeddings in each hit's `_vectors` field.\n\nThe `_vectors` field must be listed in [displayedAttributes](https://www.meilisearch.com/docs/reference/api/settings/update-all-settings#body-displayed-attributes-one-of-0) for it to appear."
+ }
+ },
+ "media": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "For [multimodal search](https://www.meilisearch.com/docs/learn/ai_powered_search/image_search_with_multimodal_embeddings): provide data (e.g. image, text) that populates a single search fragment configured in index settings.\n\nA search fragment is a named slot that defines which media or fields are sent to the embedder.\n\nAn embedder is required; this parameter is incompatible with `vector`.\n\nPOST only."
+ }
+ },
+ "personalize": {
+ "target": "com.meilisearch.api#Personalize",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "showRankingScore": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, each document includes a `_rankingScore` between 0.0 and 1.0; a higher value means the document is more relevant.\n\nSee [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score).\n\nThe `sort` ranking rule does not affect the value of `_rankingScore`."
+ }
+ },
+ "showRankingScoreDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, each document includes `_rankingScoreDetails`, which breaks down the score contribution of each [ranking rule](https://www.meilisearch.com/docs/learn/relevancy/ranking_rules).\n\nUseful for debugging relevancy."
+ }
+ },
+ "showPerformanceDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, the response includes a `performanceDetails` object with a timing breakdown of the query processing."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponseHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchHit"
+ },
+ "traits": {
+ "smithy.api#documentation": "Matching documents.\n\nEach hit contains document fields and, when requested, `_formatted`, `_matchesPosition`, `_rankingScore`, `_rankingScoreDetails`, `_geoDistance`."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponseQueryVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {
+ "smithy.api#documentation": "Query embedding used for the search.\n\nPresent when vector or hybrid search was used."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponseFacetDistributionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of matching documents per facet value for each requested facet.\n\nPresent when `facets` was set."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponseFacetStatsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetStats"
+ },
+ "traits": {
+ "smithy.api#documentation": "Minimum and maximum numeric values per facet.\n\nPresent for numeric facets when `facets` was set."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponseRemoteErrorsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ResponseError"
+ },
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Federated search only."
+ }
+ },
+ "com.meilisearch.api#SearchWithPostResponse": {
+ "type": "structure",
+ "members": {
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results per page."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Current page index (1-based)."
+ }
+ },
+ "totalPages": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of result pages."
+ }
+ },
+ "totalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of matching documents."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents skipped."
+ }
+ },
+ "estimatedTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance."
+ }
+ },
+ "hits": {
+ "target": "com.meilisearch.api#SearchWithPostResponseHitsList",
+ "traits": {
+ "smithy.api#documentation": "Matching documents.\n\nEach hit contains document fields and, when requested, `_formatted`, `_matchesPosition`, `_rankingScore`, `_rankingScoreDetails`, `_geoDistance`.",
+ "smithy.api#required": {}
+ }
+ },
+ "query": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string that produced this response.",
+ "smithy.api#required": {}
+ }
+ },
+ "queryVector": {
+ "target": "com.meilisearch.api#SearchWithPostResponseQueryVectorList",
+ "traits": {
+ "smithy.api#documentation": "Query embedding used for the search.\n\nPresent when vector or hybrid search was used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Time taken to process the query, in milliseconds.",
+ "smithy.api#required": {}
+ }
+ },
+ "facetDistribution": {
+ "target": "com.meilisearch.api#SearchWithPostResponseFacetDistributionMap",
+ "traits": {
+ "smithy.api#documentation": "Count of matching documents per facet value for each requested facet.\n\nPresent when `facets` was set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetStats": {
+ "target": "com.meilisearch.api#SearchWithPostResponseFacetStatsMap",
+ "traits": {
+ "smithy.api#documentation": "Minimum and maximum numeric values per facet.\n\nPresent for numeric facets when `facets` was set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "requestUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "UUID v7 identifying this search request.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "metadata": {
+ "target": "com.meilisearch.api#SearchMetadata",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "performanceDetails": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Timing breakdown per processing step.\n\nPresent when `showPerformanceDetails` was true."
+ }
+ },
+ "remoteErrors": {
+ "target": "com.meilisearch.api#SearchWithPostResponseRemoteErrorsMap",
+ "traits": {
+ "smithy.api#documentation": "Errors from remote shards. Federated search only.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "semanticHitCount": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive number of semantic search matches.\n\nAI-powered (hybrid/semantic) searches only.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#SearchWithPost": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SearchWithPostRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SearchWithPostResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Search with POST\n\nSearch for documents matching a query in the given index.\n\n> Equivalent to the [search with GET route](/docs/reference/api/search/search-with-get) in the Meilisearch API.\n\n**Note:** By default this endpoint returns at most 1000 results. Configure `pagination.maxTotalHits` in index settings to change this limit."
+ }
+ },
+ "com.meilisearch.api#GetAllRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SettingsUnchecked": {
+ "type": "structure",
+ "members": {
+ "displayedAttributes": {
+ "target": "com.meilisearch.api#SettingsUncheckedDisplayedAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchableAttributes": {
+ "target": "com.meilisearch.api#SettingsUncheckedSearchableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filterableAttributes": {
+ "target": "com.meilisearch.api#SettingsUncheckedFilterableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sortableAttributes": {
+ "target": "com.meilisearch.api#SettingsUncheckedSortableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "foreignKeys": {
+ "target": "com.meilisearch.api#SettingsUncheckedForeignKeysList",
+ "traits": {
+ "smithy.api#documentation": "Foreign keys to use for cross-index filtering search.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingRules": {
+ "target": "com.meilisearch.api#SettingsUncheckedRankingRulesList",
+ "traits": {
+ "smithy.api#documentation": "[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`).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "stopWords": {
+ "target": "com.meilisearch.api#SettingsUncheckedStopWordsList",
+ "traits": {
+ "smithy.api#documentation": "Words ignored when present in search queries.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "nonSeparatorTokens": {
+ "target": "com.meilisearch.api#SettingsUncheckedNonSeparatorTokensList",
+ "traits": {
+ "smithy.api#documentation": "Characters that are not treated as word separators. Removed from the default separator set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "separatorTokens": {
+ "target": "com.meilisearch.api#SettingsUncheckedSeparatorTokensList",
+ "traits": {
+ "smithy.api#documentation": "Characters that delimit words. Added on top of the default separators.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "dictionary": {
+ "target": "com.meilisearch.api#SettingsUncheckedDictionaryList",
+ "traits": {
+ "smithy.api#documentation": "Strings Meilisearch parses as a single term. Useful for names or domain terms.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "synonyms": {
+ "target": "com.meilisearch.api#SettingsUncheckedSynonymsMap",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinctAttribute": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "proximityPrecision": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Precision for the proximity ranking rule and phrase search: `byWord` (exact distance) or `byAttribute` (same attribute).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "typoTolerance": {
+ "target": "com.meilisearch.api#TypoSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "faceting": {
+ "target": "com.meilisearch.api#FacetingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "pagination": {
+ "target": "com.meilisearch.api#PaginationSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "embedders": {
+ "target": "com.meilisearch.api#SettingsUncheckedEmbeddersMap",
+ "traits": {
+ "smithy.api#documentation": "[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.).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchCutoffMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum duration of a search in milliseconds. If reached, the search stops and returns results computed so far. When null, 1500 ms is used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "localizedAttributes": {
+ "target": "com.meilisearch.api#SettingsUncheckedLocalizedAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetSearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "prefixSearch": {
+ "target": "com.meilisearch.api#PrefixSearchSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "chat": {
+ "target": "com.meilisearch.api#ChatSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedDisplayedAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedSearchableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#FilterableAttributesRule": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#String"
+ },
+ "FilterableAttributesPatterns": {
+ "target": "com.meilisearch.api#FilterableAttributesPatterns"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#FilterableAttributesPatterns": {
+ "type": "structure",
+ "members": {
+ "attributePatterns": {
+ "target": "com.meilisearch.api#FilterableAttributesPatternsAttributePatternsList",
+ "traits": {
+ "smithy.api#documentation": "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`.",
+ "smithy.api#required": {}
+ }
+ },
+ "features": {
+ "target": "com.meilisearch.api#FilterableAttributesFeatures",
+ "traits": {
+ "smithy.api#documentation": "The filtering and faceting features enabled for attributes matching\nthese patterns. If not specified, defaults to equality filtering\nenabled."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Defines a set of attribute patterns with specific filtering and faceting\nfeatures. This allows fine-grained control over which operations are\nallowed on matched attributes."
+ }
+ },
+ "com.meilisearch.api#FilterableAttributesPatternsAttributePatternsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "com.meilisearch.api#FilterableAttributesFeatures": {
+ "type": "structure",
+ "members": {
+ "facetSearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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": {
+ "target": "com.meilisearch.api#FilterFeatures",
+ "traits": {
+ "smithy.api#documentation": "Controls which filter operators are allowed for matching attributes.\nSee `FilterFeatures` for available options."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Controls which filtering and faceting operations are enabled for matching\nattributes. This allows restricting certain operations on specific fields\nfor security or performance reasons."
+ }
+ },
+ "com.meilisearch.api#FilterFeatures": {
+ "type": "structure",
+ "members": {
+ "equality": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, enables comparison operators: `<`, `>`, `<=`, `>=`, and\n`TO` (range). These allow filtering based on numeric or string\ncomparisons. Defaults to `false`."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Controls which filter operators are allowed for an attribute. This\nprovides fine-grained control over filtering capabilities."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedFilterableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#FilterableAttributesRule"
+ },
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedSortableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results)."
+ }
+ },
+ "com.meilisearch.api#ForeignKey": {
+ "type": "structure",
+ "members": {
+ "foreignIndexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "fieldName": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SettingsUncheckedForeignKeysList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ForeignKey"
+ },
+ "traits": {
+ "smithy.api#documentation": "Foreign keys to use for cross-index filtering search."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedRankingRulesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "[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`)."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedStopWordsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Words ignored when present in search queries."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedNonSeparatorTokensList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Characters that are not treated as word separators. Removed from the default separator set."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedSeparatorTokensList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Characters that delimit words. Added on top of the default separators."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedDictionaryList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Strings Meilisearch parses as a single term. Useful for names or domain terms."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedSynonymsValueList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SettingsUncheckedSynonymsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#SettingsUncheckedSynonymsValueList"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#TypoSettings": {
+ "type": "structure",
+ "members": {
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, typo tolerance is enabled. When false, only exact matches are returned.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "minWordSizeForTypos": {
+ "target": "com.meilisearch.api#MinWordSizeTyposSetting",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnWords": {
+ "target": "com.meilisearch.api#TypoSettingsDisableOnWordsList",
+ "traits": {
+ "smithy.api#documentation": "Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnAttributes": {
+ "target": "com.meilisearch.api#TypoSettingsDisableOnAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnNumbers": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, typo tolerance is disabled on numeric tokens. For example, 123 will not match 132.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Typo tolerance: how spelling mistakes in queries are handled."
+ }
+ },
+ "com.meilisearch.api#MinWordSizeTyposSetting": {
+ "type": "structure",
+ "members": {
+ "oneTypo": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "twoTypos": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Minimum word length required before typos are allowed.\n\nThis helps prevent matching very short words with typos, which can lead to irrelevant results."
+ }
+ },
+ "com.meilisearch.api#TypoSettingsDisableOnWordsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly."
+ }
+ },
+ "com.meilisearch.api#TypoSettingsDisableOnAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs."
+ }
+ },
+ "com.meilisearch.api#FacetingSettings": {
+ "type": "structure",
+ "members": {
+ "maxValuesPerFacet": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of facet values returned per facet. Values are sorted in ascending lexicographical order.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sortFacetValuesBy": {
+ "target": "com.meilisearch.api#FacetingSettingsSortFacetValuesByMap",
+ "traits": {
+ "smithy.api#documentation": "Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Faceting: maximum number of facet values and how they are sorted."
+ }
+ },
+ "com.meilisearch.api#FacetingSettingsSortFacetValuesByMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetValuesSort"
+ },
+ "traits": {
+ "smithy.api#documentation": "Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets."
+ }
+ },
+ "com.meilisearch.api#PaginationSettings": {
+ "type": "structure",
+ "members": {
+ "maxTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of search results Meilisearch can return. Limit and offset cannot go beyond this value.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Pagination: cap on how many results a search can return."
+ }
+ },
+ "com.meilisearch.api#EmbeddingSettings": {
+ "type": "structure",
+ "members": {
+ "source": {
+ "target": "com.meilisearch.api#EmbedderSource",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "model": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "revision": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "pooling": {
+ "target": "com.meilisearch.api#OverridePooling",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "apiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {},
+ "smithy.api#sensitive": {}
+ }
+ },
+ "dimensions": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "binaryQuantized": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexingFragments": {
+ "target": "com.meilisearch.api#EmbeddingSettingsIndexingFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchFragments": {
+ "target": "com.meilisearch.api#EmbeddingSettingsSearchFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "request": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "response": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#EmbeddingSettingsHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchEmbedder": {
+ "target": "com.meilisearch.api#SubEmbeddingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexingEmbedder": {
+ "target": "com.meilisearch.api#SubEmbeddingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distribution": {
+ "target": "com.meilisearch.api#DistributionShift",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Embedder configuration for [AI-powered / hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search)."
+ }
+ },
+ "com.meilisearch.api#EmbedderSource": {
+ "type": "enum",
+ "members": {
+ "OPENAI": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "openAi"
+ }
+ },
+ "HUGGINGFACE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "huggingFace"
+ }
+ },
+ "OLLAMA": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "ollama"
+ }
+ },
+ "USERPROVIDED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "userProvided"
+ }
+ },
+ "REST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "rest"
+ }
+ },
+ "COMPOSITE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "composite"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#OverridePooling": {
+ "type": "enum",
+ "members": {
+ "USEMODEL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "useModel"
+ }
+ },
+ "FORCECLS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "forceCls"
+ }
+ },
+ "FORCEMEAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "forceMean"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#EmbeddingSettingsIndexingFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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."
+ }
+ },
+ "com.meilisearch.api#EmbeddingSettingsSearchFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "com.meilisearch.api#EmbeddingSettingsHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings"
+ }
+ },
+ "com.meilisearch.api#SubEmbeddingSettings": {
+ "type": "structure",
+ "members": {
+ "source": {
+ "target": "com.meilisearch.api#EmbedderSource",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "model": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "revision": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "pooling": {
+ "target": "com.meilisearch.api#OverridePooling",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "apiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {},
+ "smithy.api#sensitive": {}
+ }
+ },
+ "dimensions": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexingFragments": {
+ "target": "com.meilisearch.api#SubEmbeddingSettingsIndexingFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchFragments": {
+ "target": "com.meilisearch.api#SubEmbeddingSettingsSearchFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "request": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "response": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#SubEmbeddingSettingsHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sub-embedder config for composite embedders. Used by `indexingEmbedder` (vectorize documents at index time) and `searchEmbedder` (vectorize queries at search time). Same fields as a top-level embedder, except no `binaryQuantized`, `distribution`, `documentTemplate`/`documentTemplateMaxBytes` for searchEmbedder."
+ }
+ },
+ "com.meilisearch.api#SubEmbeddingSettingsIndexingFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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."
+ }
+ },
+ "com.meilisearch.api#SubEmbeddingSettingsSearchFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "com.meilisearch.api#SubEmbeddingSettingsHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings"
+ }
+ },
+ "com.meilisearch.api#DistributionShift": {
+ "type": "structure",
+ "members": {
+ "current_mean": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Value where the results are \"packed\".\n\nSimilarity scores are translated so that they are packed around 0.5 instead",
+ "smithy.api#required": {}
+ }
+ },
+ "current_sigma": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Describes the mean and sigma of distribution of embedding similarity in the embedding space.\n\nThe intended use is to make the similarity score more comparable to the regular ranking score.\nThis allows to correct effects where results are too \"packed\" around a certain value."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedEmbeddersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#EmbeddingSettings"
+ },
+ "traits": {
+ "smithy.api#documentation": "[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.)."
+ }
+ },
+ "com.meilisearch.api#LocalizedAttributesRuleView": {
+ "type": "structure",
+ "members": {
+ "attributePatterns": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleViewAttributePatternsList",
+ "traits": {
+ "smithy.api#documentation": "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`.",
+ "smithy.api#required": {}
+ }
+ },
+ "locales": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleViewLocalesList",
+ "traits": {
+ "smithy.api#documentation": "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\"]`.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "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."
+ }
+ },
+ "com.meilisearch.api#LocalizedAttributesRuleViewAttributePatternsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "com.meilisearch.api#LocalizedAttributesRuleViewLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Locale"
+ },
+ "traits": {
+ "smithy.api#documentation": "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\"]`."
+ }
+ },
+ "com.meilisearch.api#SettingsUncheckedLocalizedAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleView"
+ },
+ "traits": {
+ "smithy.api#documentation": "Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes."
+ }
+ },
+ "com.meilisearch.api#PrefixSearchSettings": {
+ "type": "enum",
+ "members": {
+ "INDEXINGTIME": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexingTime"
+ }
+ },
+ "DISABLED": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "disabled"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ChatSettings": {
+ "type": "structure",
+ "members": {
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Index description shown to the LLM so it can decide when and how to query this index.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Liquid template that defines the text sent to the LLM for each document.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum size in bytes of the rendered document template. Longer text is truncated.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchParameters": {
+ "target": "com.meilisearch.api#ChatSearchParams",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "[Chat (conversation)](https://www.meilisearch.com/docs/learn/chat/getting_started_with_chat) settings: how the index is described to the LLM and how it is queried."
+ }
+ },
+ "com.meilisearch.api#ChatSearchParams": {
+ "type": "structure",
+ "members": {
+ "hybrid": {
+ "target": "com.meilisearch.api#HybridQuery",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned per search performed by the LLM.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sort": {
+ "target": "com.meilisearch.api#ChatSearchParamsSortList",
+ "traits": {
+ "smithy.api#documentation": "Sort order: array of strings like `attribute:asc` or `attribute:desc`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Attribute used to return at most one document per distinct value.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "matchingStrategy": {
+ "target": "com.meilisearch.api#MatchingStrategy",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "attributesToSearchOn": {
+ "target": "com.meilisearch.api#ChatSearchParamsAttributesToSearchOnList",
+ "traits": {
+ "smithy.api#documentation": "Attributes on which to run the search. If unset, all searchable attributes are used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Search parameters applied when the LLM queries this index."
+ }
+ },
+ "com.meilisearch.api#ChatSearchParamsSortList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Sort order: array of strings like `attribute:asc` or `attribute:desc`."
+ }
+ },
+ "com.meilisearch.api#ChatSearchParamsAttributesToSearchOnList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes on which to run the search. If unset, all searchable attributes are used."
+ }
+ },
+ "com.meilisearch.api#GetAll": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetAllRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SettingsUnchecked"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "List all settings\n\nReturns all settings of the index. Each setting is returned with its current value or the default if not set."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestDisplayedAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestSearchableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestFilterableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#FilterableAttributesRule"
+ },
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestSortableAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestForeignKeysList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ForeignKey"
+ },
+ "traits": {
+ "smithy.api#documentation": "Foreign keys to use for cross-index filtering search."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestRankingRulesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "[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`)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestStopWordsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Words ignored when present in search queries."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestNonSeparatorTokensList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Characters that are not treated as word separators. Removed from the default separator set."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestSeparatorTokensList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Characters that delimit words. Added on top of the default separators."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestDictionaryList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Strings Meilisearch parses as a single term. Useful for names or domain terms."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestSynonymsValueList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#UpdateAllRequestSynonymsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#UpdateAllRequestSynonymsValueList"
+ },
+ "traits": {
+ "smithy.api#documentation": "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)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestEmbeddersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#EmbeddingSettings"
+ },
+ "traits": {
+ "smithy.api#documentation": "[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.)."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequestLocalizedAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleView"
+ },
+ "traits": {
+ "smithy.api#documentation": "Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes."
+ }
+ },
+ "com.meilisearch.api#UpdateAllRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "displayedAttributes": {
+ "target": "com.meilisearch.api#UpdateAllRequestDisplayedAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchableAttributes": {
+ "target": "com.meilisearch.api#UpdateAllRequestSearchableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "filterableAttributes": {
+ "target": "com.meilisearch.api#UpdateAllRequestFilterableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "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`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sortableAttributes": {
+ "target": "com.meilisearch.api#UpdateAllRequestSortableAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Attributes that can be used to [sort search results](https://www.meilisearch.com/docs/learn/filtering_and_sorting/sort_search_results).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "foreignKeys": {
+ "target": "com.meilisearch.api#UpdateAllRequestForeignKeysList",
+ "traits": {
+ "smithy.api#documentation": "Foreign keys to use for cross-index filtering search.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingRules": {
+ "target": "com.meilisearch.api#UpdateAllRequestRankingRulesList",
+ "traits": {
+ "smithy.api#documentation": "[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`).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "stopWords": {
+ "target": "com.meilisearch.api#UpdateAllRequestStopWordsList",
+ "traits": {
+ "smithy.api#documentation": "Words ignored when present in search queries.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "nonSeparatorTokens": {
+ "target": "com.meilisearch.api#UpdateAllRequestNonSeparatorTokensList",
+ "traits": {
+ "smithy.api#documentation": "Characters that are not treated as word separators. Removed from the default separator set.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "separatorTokens": {
+ "target": "com.meilisearch.api#UpdateAllRequestSeparatorTokensList",
+ "traits": {
+ "smithy.api#documentation": "Characters that delimit words. Added on top of the default separators.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "dictionary": {
+ "target": "com.meilisearch.api#UpdateAllRequestDictionaryList",
+ "traits": {
+ "smithy.api#documentation": "Strings Meilisearch parses as a single term. Useful for names or domain terms.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "synonyms": {
+ "target": "com.meilisearch.api#UpdateAllRequestSynonymsMap",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinctAttribute": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "proximityPrecision": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Precision for the proximity ranking rule and phrase search: `byWord` (exact distance) or `byAttribute` (same attribute).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "typoTolerance": {
+ "target": "com.meilisearch.api#TypoSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "faceting": {
+ "target": "com.meilisearch.api#FacetingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "pagination": {
+ "target": "com.meilisearch.api#PaginationSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "embedders": {
+ "target": "com.meilisearch.api#UpdateAllRequestEmbeddersMap",
+ "traits": {
+ "smithy.api#documentation": "[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.).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchCutoffMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum duration of a search in milliseconds. If reached, the search stops and returns results computed so far. When null, 1500 ms is used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "localizedAttributes": {
+ "target": "com.meilisearch.api#UpdateAllRequestLocalizedAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Locales and attribute patterns for [language-specific tokenization](https://www.meilisearch.com/docs/learn/resources/language). Affects searchable, filterable, and sortable attributes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetSearch": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "prefixSearch": {
+ "target": "com.meilisearch.api#PrefixSearchSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "chat": {
+ "target": "com.meilisearch.api#ChatSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#UpdateAll": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#UpdateAllRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update all settings\n\nUpdates 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)."
+ }
+ },
+ "com.meilisearch.api#DeleteAllRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteAll": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteAllRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset all settings\n\nResets all settings of the index to their default values."
+ }
+ },
+ "com.meilisearch.api#GetchatRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Getchat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetchatRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#ChatSettings"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/chat",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get chat\n\nReturns the current value of the `chat` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PatchchatRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Index description shown to the LLM so it can decide when and how to query this index.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Liquid template that defines the text sent to the LLM for each document.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum size in bytes of the rendered document template. Longer text is truncated.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchParameters": {
+ "target": "com.meilisearch.api#ChatSearchParams",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Patchchat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchchatRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings/chat",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update chat\n\nUpdates the `chat` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletechatRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deletechat": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletechatRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/chat",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset chat\n\nResets the `chat` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetdictionaryRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetdictionaryResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetdictionaryResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetdictionaryResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#Getdictionary": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetdictionaryRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetdictionaryResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/dictionary",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get dictionary\n\nReturns the current value of the `dictionary` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutdictionaryRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutdictionaryRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutdictionaryRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Putdictionary": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutdictionaryRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/dictionary",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update dictionary\n\nUpdates the `dictionary` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletedictionaryRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deletedictionary": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletedictionaryRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/dictionary",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset dictionary\n\nResets the `dictionary` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetdisplayedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetdisplayedAttributesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetdisplayedAttributesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetdisplayedAttributesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetdisplayedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetdisplayedAttributesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetdisplayedAttributesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/displayed-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get displayedAttributes\n\nReturns the current value of the `displayedAttributes` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutdisplayedAttributesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutdisplayedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutdisplayedAttributesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutdisplayedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutdisplayedAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/displayed-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update displayedAttributes\n\nUpdates the `displayedAttributes` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletedisplayedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletedisplayedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletedisplayedAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/displayed-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset displayedAttributes\n\nResets the `displayedAttributes` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetdistinctAttributeRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetdistinctAttributeResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetdistinctAttribute": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetdistinctAttributeRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetdistinctAttributeResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/distinct-attribute",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get distinctAttribute\n\nReturns the current value of the `distinctAttribute` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutdistinctAttributeRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutdistinctAttribute": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutdistinctAttributeRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/distinct-attribute",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update distinctAttribute\n\nUpdates the `distinctAttribute` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletedistinctAttributeRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletedistinctAttribute": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletedistinctAttributeRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/distinct-attribute",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset distinctAttribute\n\nResets the `distinctAttribute` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetembeddersRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SettingEmbeddingSettings": {
+ "type": "structure",
+ "members": {
+ "inner": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettingsInner",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Configuration for one [embedder](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search) used for semantic and hybrid search.\n\nSet `source` (`openAi`, `huggingFace`, `ollama`, `rest`, `userProvided`), then the options that apply: `model`, `apiKey`, `documentTemplate`, `dimensions`, `url`, etc."
+ }
+ },
+ "com.meilisearch.api#SettingEmbeddingSettingsInnerIndexingFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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."
+ }
+ },
+ "com.meilisearch.api#SettingEmbeddingSettingsInnerSearchFragmentsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Document"
+ },
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "com.meilisearch.api#SettingEmbeddingSettingsInnerHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings"
+ }
+ },
+ "com.meilisearch.api#SettingEmbeddingSettingsInner": {
+ "type": "structure",
+ "members": {
+ "source": {
+ "target": "com.meilisearch.api#EmbedderSource",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "model": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "revision": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "pooling": {
+ "target": "com.meilisearch.api#OverridePooling",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "apiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {},
+ "smithy.api#sensitive": {}
+ }
+ },
+ "dimensions": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "binaryQuantized": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "[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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexingFragments": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettingsInnerIndexingFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchFragments": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettingsInnerSearchFragmentsMap",
+ "traits": {
+ "smithy.api#documentation": "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",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "request": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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"
+ }
+ },
+ "response": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "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`."
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettingsInnerHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "Extra HTTP headers sent to the embedder.\n\n- Available for `rest`.\n- 🌱 Changing the value of this parameter never regenerates embeddings",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchEmbedder": {
+ "target": "com.meilisearch.api#SubEmbeddingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexingEmbedder": {
+ "target": "com.meilisearch.api#SubEmbeddingSettings",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distribution": {
+ "target": "com.meilisearch.api#DistributionShift",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Embedder configuration for [AI-powered / hybrid search](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search)."
+ }
+ },
+ "com.meilisearch.api#GetembeddersResponseBodyMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettings"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetembeddersResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetembeddersResponseBodyMap",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#Getembedders": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetembeddersRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetembeddersResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/embedders",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get embedders\n\nReturns the current value of the `embedders` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PatchembeddersRequestBodyMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#SettingEmbeddingSettings"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PatchembeddersRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PatchembeddersRequestBodyMap",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Patchembedders": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchembeddersRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings/embedders",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update embedders\n\nUpdates the `embedders` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleteembeddersRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deleteembedders": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteembeddersRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/embedders",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset embedders\n\nResets the `embedders` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetfacetSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetfacetSearchResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetfacetSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetfacetSearchRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetfacetSearchResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/facet-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get facetSearch\n\nReturns the current value of the `facetSearch` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutfacetSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutfacetSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutfacetSearchRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/facet-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update facetSearch\n\nUpdates the `facetSearch` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletefacetSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletefacetSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletefacetSearchRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/facet-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset facetSearch\n\nResets the `facetSearch` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetfacetingRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Getfaceting": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetfacetingRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#FacetingSettings"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/faceting",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get faceting\n\nReturns the current value of the `faceting` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PatchfacetingRequestSortFacetValuesByMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetValuesSort"
+ },
+ "traits": {
+ "smithy.api#documentation": "Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets."
+ }
+ },
+ "com.meilisearch.api#PatchfacetingRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "maxValuesPerFacet": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of facet values returned per facet. Values are sorted in ascending lexicographical order.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "sortFacetValuesBy": {
+ "target": "com.meilisearch.api#PatchfacetingRequestSortFacetValuesByMap",
+ "traits": {
+ "smithy.api#documentation": "Sort order per facet: by descending count (`count`) or ascending alphanumeric (`alpha`). Key `*` applies to all facets.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Patchfaceting": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchfacetingRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings/faceting",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update faceting\n\nUpdates the `faceting` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletefacetingRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deletefaceting": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletefacetingRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/faceting",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset faceting\n\nResets the `faceting` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetfilterableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetfilterableAttributesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#FilterableAttributesRule"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetfilterableAttributesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetfilterableAttributesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetfilterableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetfilterableAttributesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetfilterableAttributesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/filterable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get filterableAttributes\n\nReturns the current value of the `filterableAttributes` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutfilterableAttributesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#FilterableAttributesRule"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutfilterableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutfilterableAttributesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutfilterableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutfilterableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/filterable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update filterableAttributes\n\nUpdates the `filterableAttributes` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletefilterableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletefilterableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletefilterableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/filterable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset filterableAttributes\n\nResets the `filterableAttributes` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetforeignKeysRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetforeignKeysResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ForeignKey"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetforeignKeysResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetforeignKeysResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetforeignKeys": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetforeignKeysRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetforeignKeysResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/foreign-keys",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get foreignKeys\n\nReturns the current value of the `foreignKeys` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutforeignKeysRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#ForeignKey"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutforeignKeysRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutforeignKeysRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutforeignKeys": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutforeignKeysRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/foreign-keys",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update foreignKeys\n\nUpdates the `foreignKeys` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleteforeignKeysRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteforeignKeys": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteforeignKeysRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/foreign-keys",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset foreignKeys\n\nResets the `foreignKeys` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetlocalizedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetlocalizedAttributesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleView"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetlocalizedAttributesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetlocalizedAttributesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetlocalizedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetlocalizedAttributesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetlocalizedAttributesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/localized-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get localizedAttributes\n\nReturns the current value of the `localizedAttributes` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutlocalizedAttributesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#LocalizedAttributesRuleView"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutlocalizedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutlocalizedAttributesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutlocalizedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutlocalizedAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/localized-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update localizedAttributes\n\nUpdates the `localizedAttributes` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletelocalizedAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletelocalizedAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletelocalizedAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/localized-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset localizedAttributes\n\nResets the `localizedAttributes` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetnonSeparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetnonSeparatorTokensResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetnonSeparatorTokensResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetnonSeparatorTokensResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetnonSeparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetnonSeparatorTokensRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetnonSeparatorTokensResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/non-separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get nonSeparatorTokens\n\nReturns the current value of the `nonSeparatorTokens` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutnonSeparatorTokensRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutnonSeparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutnonSeparatorTokensRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutnonSeparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutnonSeparatorTokensRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/non-separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update nonSeparatorTokens\n\nUpdates the `nonSeparatorTokens` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletenonSeparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletenonSeparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletenonSeparatorTokensRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/non-separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset nonSeparatorTokens\n\nResets the `nonSeparatorTokens` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetpaginationRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Getpagination": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetpaginationRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationSettings"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/pagination",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get pagination\n\nReturns the current value of the `pagination` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PatchpaginationRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "maxTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of search results Meilisearch can return. Limit and offset cannot go beyond this value.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Patchpagination": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchpaginationRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings/pagination",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update pagination\n\nUpdates the `pagination` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletepaginationRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deletepagination": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletepaginationRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/pagination",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset pagination\n\nResets the `pagination` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetprefixSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetprefixSearchResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#PrefixSearchSettings",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetprefixSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetprefixSearchRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetprefixSearchResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/prefix-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get prefixSearch\n\nReturns the current value of the `prefixSearch` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutprefixSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PrefixSearchSettings",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutprefixSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutprefixSearchRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/prefix-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update prefixSearch\n\nUpdates the `prefixSearch` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleteprefixSearchRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteprefixSearch": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteprefixSearchRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/prefix-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset prefixSearch\n\nResets the `prefixSearch` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetproximityPrecisionRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#ProximityPrecisionView": {
+ "type": "enum",
+ "members": {
+ "BYWORD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "byWord"
+ }
+ },
+ "BYATTRIBUTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "byAttribute"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetproximityPrecisionResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#ProximityPrecisionView",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetproximityPrecision": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetproximityPrecisionRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetproximityPrecisionResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/proximity-precision",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get proximityPrecision\n\nReturns the current value of the `proximityPrecision` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutproximityPrecisionRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#ProximityPrecisionView",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutproximityPrecision": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutproximityPrecisionRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/proximity-precision",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update proximityPrecision\n\nUpdates the `proximityPrecision` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleteproximityPrecisionRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteproximityPrecision": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteproximityPrecisionRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/proximity-precision",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset proximityPrecision\n\nResets the `proximityPrecision` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetrankingRulesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#RankingRuleView": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#RankingRuleViewCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#RankingRuleViewCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#RankingRuleViewCase2"
+ },
+ "Case3": {
+ "target": "com.meilisearch.api#RankingRuleViewCase3"
+ },
+ "Case4": {
+ "target": "com.meilisearch.api#RankingRuleViewCase4"
+ },
+ "Case5": {
+ "target": "com.meilisearch.api#RankingRuleViewCase5"
+ },
+ "Case6": {
+ "target": "com.meilisearch.api#RankingRuleViewCase6"
+ },
+ "Case7": {
+ "target": "com.meilisearch.api#RankingRuleViewCase7"
+ },
+ "Case8": {
+ "target": "com.meilisearch.api#RankingRuleViewCase8"
+ },
+ "Case9": {
+ "target": "com.meilisearch.api#RankingRuleViewCase9"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RankingRuleViewCase0": {
+ "type": "enum",
+ "members": {
+ "WORDS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "words"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by decreasing number of matched query terms."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase1": {
+ "type": "enum",
+ "members": {
+ "TYPO": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "typo"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by increasing number of typos."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase2": {
+ "type": "enum",
+ "members": {
+ "PROXIMITY": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "proximity"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by increasing distance between matched query terms."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase3": {
+ "type": "enum",
+ "members": {
+ "ATTRIBUTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "attribute"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Documents with query words contained in more important\nattributes and at a closer-to-the-front position in it\nare considered better."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase4": {
+ "type": "enum",
+ "members": {
+ "ATTRIBUTERANK": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "attributeRank"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Documents with query words contained in more important\nattributes are considered better. Position of the\nquery words in an attribute is not considered."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase5": {
+ "type": "enum",
+ "members": {
+ "WORDPOSITION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "wordPosition"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Documents with query words that are closer to the front\nof an attribute are considered better. Attribute rank\nis not considered."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase6": {
+ "type": "enum",
+ "members": {
+ "SORT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "sort"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Dynamically sort at query time the documents. None, one or multiple\nAsc/Desc sortable attributes can be used in place of this criterion at\nquery time."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase7": {
+ "type": "enum",
+ "members": {
+ "EXACTNESS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "exactness"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by the similarity of the matched words with the query words."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase8": {
+ "type": "structure",
+ "members": {
+ "asc": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Sorted by the increasing value of the field specified.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by the increasing value of the field specified."
+ }
+ },
+ "com.meilisearch.api#RankingRuleViewCase9": {
+ "type": "structure",
+ "members": {
+ "desc": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Sorted by the decreasing value of the field specified.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Sorted by the decreasing value of the field specified."
+ }
+ },
+ "com.meilisearch.api#GetrankingRulesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#RankingRuleView"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetrankingRulesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetrankingRulesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetrankingRules": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetrankingRulesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetrankingRulesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/ranking-rules",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get rankingRules\n\nReturns the current value of the `rankingRules` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutrankingRulesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#RankingRuleView"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutrankingRulesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutrankingRulesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutrankingRules": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutrankingRulesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/ranking-rules",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update rankingRules\n\nUpdates the `rankingRules` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleterankingRulesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleterankingRules": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleterankingRulesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/ranking-rules",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset rankingRules\n\nResets the `rankingRules` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetsearchCutoffMsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetsearchCutoffMsResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetsearchCutoffMs": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetsearchCutoffMsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetsearchCutoffMsResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/search-cutoff-ms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get searchCutoffMs\n\nReturns the current value of the `searchCutoffMs` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutsearchCutoffMsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutsearchCutoffMs": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutsearchCutoffMsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/search-cutoff-ms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update searchCutoffMs\n\nUpdates the `searchCutoffMs` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletesearchCutoffMsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletesearchCutoffMs": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletesearchCutoffMsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/search-cutoff-ms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset searchCutoffMs\n\nResets the `searchCutoffMs` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetsearchableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetsearchableAttributesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetsearchableAttributesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetsearchableAttributesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetsearchableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetsearchableAttributesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetsearchableAttributesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/searchable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get searchableAttributes\n\nReturns the current value of the `searchableAttributes` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutsearchableAttributesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutsearchableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutsearchableAttributesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutsearchableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutsearchableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/searchable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update searchableAttributes\n\nUpdates the `searchableAttributes` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletesearchableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletesearchableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletesearchableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/searchable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset searchableAttributes\n\nResets the `searchableAttributes` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetseparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetseparatorTokensResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetseparatorTokensResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetseparatorTokensResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetseparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetseparatorTokensRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetseparatorTokensResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get separatorTokens\n\nReturns the current value of the `separatorTokens` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutseparatorTokensRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutseparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutseparatorTokensRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutseparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutseparatorTokensRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update separatorTokens\n\nUpdates the `separatorTokens` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeleteseparatorTokensRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteseparatorTokens": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteseparatorTokensRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/separator-tokens",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset separatorTokens\n\nResets the `separatorTokens` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetsortableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetsortableAttributesResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetsortableAttributesResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetsortableAttributesResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetsortableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetsortableAttributesRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetsortableAttributesResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/sortable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get sortableAttributes\n\nReturns the current value of the `sortableAttributes` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutsortableAttributesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutsortableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutsortableAttributesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutsortableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutsortableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/sortable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update sortableAttributes\n\nUpdates the `sortableAttributes` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletesortableAttributesRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletesortableAttributes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletesortableAttributesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/sortable-attributes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset sortableAttributes\n\nResets the `sortableAttributes` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetstopWordsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetstopWordsResponseBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetstopWordsResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetstopWordsResponseBodyList",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetstopWords": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetstopWordsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetstopWordsResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/stop-words",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get stopWords\n\nReturns the current value of the `stopWords` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutstopWordsRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutstopWordsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutstopWordsRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PutstopWords": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutstopWordsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/stop-words",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update stopWords\n\nUpdates the `stopWords` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletestopWordsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletestopWords": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletestopWordsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/stop-words",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset stopWords\n\nResets the `stopWords` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GetsynonymsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetsynonymsResponseBodyValueList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetsynonymsResponseBodyMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#GetsynonymsResponseBodyValueList"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetsynonymsResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#GetsynonymsResponseBodyMap",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#Getsynonyms": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetsynonymsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetsynonymsResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/synonyms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get synonyms\n\nReturns the current value of the `synonyms` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PutsynonymsRequestBodyValueList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutsynonymsRequestBodyMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#PutsynonymsRequestBodyValueList"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PutsynonymsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "body": {
+ "target": "com.meilisearch.api#PutsynonymsRequestBodyMap",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Putsynonyms": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PutsynonymsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PUT",
+ "uri": "/indexes/{index_uid}/settings/synonyms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update synonyms\n\nUpdates the `synonyms` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletesynonymsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Deletesynonyms": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletesynonymsRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/synonyms",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset synonyms\n\nResets the `synonyms` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#GettypoToleranceRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GettypoTolerance": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GettypoToleranceRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#TypoSettings"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/settings/typo-tolerance",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get typoTolerance\n\nReturns the current value of the `typoTolerance` setting for the index."
+ }
+ },
+ "com.meilisearch.api#PatchtypoToleranceRequestDisableOnWordsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly."
+ }
+ },
+ "com.meilisearch.api#PatchtypoToleranceRequestDisableOnAttributesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs."
+ }
+ },
+ "com.meilisearch.api#PatchtypoToleranceRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "enabled": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, typo tolerance is enabled. When false, only exact matches are returned.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "minWordSizeForTypos": {
+ "target": "com.meilisearch.api#MinWordSizeTyposSetting",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnWords": {
+ "target": "com.meilisearch.api#PatchtypoToleranceRequestDisableOnWordsList",
+ "traits": {
+ "smithy.api#documentation": "Words for which typo tolerance is disabled. Use for brand names or terms that must match exactly.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnAttributes": {
+ "target": "com.meilisearch.api#PatchtypoToleranceRequestDisableOnAttributesList",
+ "traits": {
+ "smithy.api#documentation": "Attributes for which typo tolerance is disabled. Those attributes only return exact matches. Useful for fields like product codes or IDs.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "disableOnNumbers": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When true, typo tolerance is disabled on numeric tokens. For example, 123 will not match 132.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchtypoTolerance": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchtypoToleranceRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/indexes/{index_uid}/settings/typo-tolerance",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update typoTolerance\n\nUpdates the `typoTolerance` setting for the index. Send the new value in the request body; send null to reset to default."
+ }
+ },
+ "com.meilisearch.api#DeletetypoToleranceRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeletetypoTolerance": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeletetypoToleranceRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/indexes/{index_uid}/settings/typo-tolerance",
+ "code": 200
+ },
+ "smithy.api#documentation": "Reset typoTolerance\n\nResets the `typoTolerance` setting to its default value."
+ }
+ },
+ "com.meilisearch.api#SimilarGetRequestAttributesToRetrieveList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SimilarGetRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "id",
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The unique identifier ([primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value) of the target document.\nMeilisearch will find and return documents that are semantically\nsimilar to this document based on their vector embeddings. This is a\nrequired parameter."
+ }
+ },
+ "embedder": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "embedder",
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The name of the embedder to use for finding similar documents. This\nmust match one of the embedders configured in your index settings. The\nembedder determines how document similarity is calculated based on\nvector embeddings."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "offset",
+ "smithy.api#documentation": "Number of similar documents to skip in the response. Use together with\n`limit` for pagination through large result sets. For example, to get\nsimilar documents 21-40, set `offset=20` and `limit=20`. Defaults to\n`0`."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of similar documents to return in a single response. Use\ntogether with `offset` for pagination. Higher values return more\nresults but may increase response time. Defaults to `20`."
+ }
+ },
+ "attributes_to_retrieve": {
+ "target": "com.meilisearch.api#SimilarGetRequestAttributesToRetrieveList",
+ "traits": {
+ "smithy.api#httpQuery": "attributes_to_retrieve",
+ "smithy.api#documentation": "Comma-separated list of document attributes to include in the response.\nUse `*` to retrieve all attributes. By default, all attributes listed\nin the `displayedAttributes` setting are returned. Example:\n`title,description,price`."
+ }
+ },
+ "retrieve_vectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "retrieve_vectors",
+ "smithy.api#documentation": "When `true`, includes the vector embeddings for each returned document.\nUseful for debugging or when you need to inspect the vector data. Note\nthat this can significantly increase response size. Defaults to\n`false`."
+ }
+ },
+ "filter": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "filter",
+ "smithy.api#documentation": "Filter expression to narrow down which documents can be returned as\nsimilar. Uses the same syntax as search filters. Only documents\nmatching this filter will be considered when finding similar documents.\nExample: `genres = action AND year > 2000`."
+ }
+ },
+ "show_ranking_score": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "show_ranking_score",
+ "smithy.api#documentation": "When `true`, includes a global `_rankingScore` field in each document\nshowing how similar it is to the target document. The score is a value\nbetween 0 and 1, where higher values indicate greater similarity.\nDefaults to `false`."
+ }
+ },
+ "show_ranking_score_details": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "show_ranking_score_details",
+ "smithy.api#documentation": "When `true`, includes a detailed `_rankingScoreDetails` object in each\ndocument breaking down how the similarity score was calculated. Useful\nfor debugging and understanding why certain documents are considered\nmore similar. Defaults to `false`."
+ }
+ },
+ "show_performance_details": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "show_performance_details",
+ "smithy.api#documentation": "When `true`, includes a `_performanceDetails` object showing the\nperformance details of the search."
+ }
+ },
+ "ranking_score_threshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#httpQuery": "ranking_score_threshold",
+ "smithy.api#documentation": "Minimum ranking score threshold (between 0.0 and 1.0) that documents\nmust meet to be included in results. Documents with a similarity score\nbelow this threshold will be excluded. Useful for ensuring only highly\nsimilar documents are returned."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SimilarGetResponseHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchHit"
+ },
+ "traits": {
+ "smithy.api#documentation": "Results of the query"
+ }
+ },
+ "com.meilisearch.api#SimilarGetResponse": {
+ "type": "structure",
+ "members": {
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results per page."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Current page index (1-based)."
+ }
+ },
+ "totalPages": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of result pages."
+ }
+ },
+ "totalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of matching documents."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents skipped."
+ }
+ },
+ "estimatedTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance."
+ }
+ },
+ "hits": {
+ "target": "com.meilisearch.api#SimilarGetResponseHitsList",
+ "traits": {
+ "smithy.api#documentation": "Results of the query",
+ "smithy.api#required": {}
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Document ID that was used as reference",
+ "smithy.api#required": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Processing time of the query in milliseconds",
+ "smithy.api#required": {}
+ }
+ },
+ "performanceDetails": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Performance details of the query"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#SimilarGet": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SimilarGetRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SimilarGetResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/similar",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get similar documents with GET\n\nRetrieve documents similar to a reference document identified by its id.\n\n> Useful for “more like this” or recommendations."
+ }
+ },
+ "com.meilisearch.api#SimilarPostRequestAttributesToRetrieveList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes to display in the returned documents"
+ }
+ },
+ "com.meilisearch.api#SimilarPostRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Document ID to find similar documents for",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents to skip"
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned"
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter queries by an attribute's value"
+ }
+ },
+ "embedder": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the embedder to use for semantic similarity",
+ "smithy.api#required": {}
+ }
+ },
+ "attributesToRetrieve": {
+ "target": "com.meilisearch.api#SimilarPostRequestAttributesToRetrieveList",
+ "traits": {
+ "smithy.api#documentation": "Attributes to display in the returned documents",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Return document vector data"
+ }
+ },
+ "showRankingScore": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Display the global ranking score of a document"
+ }
+ },
+ "showRankingScoreDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Adds a detailed global ranking score field"
+ }
+ },
+ "showPerformanceDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Adds a detailed performance details field"
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Excludes results with low ranking scores"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SimilarPostResponseHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchHit"
+ },
+ "traits": {
+ "smithy.api#documentation": "Results of the query"
+ }
+ },
+ "com.meilisearch.api#SimilarPostResponse": {
+ "type": "structure",
+ "members": {
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results per page."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Current page index (1-based)."
+ }
+ },
+ "totalPages": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of result pages."
+ }
+ },
+ "totalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of matching documents."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents skipped."
+ }
+ },
+ "estimatedTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance."
+ }
+ },
+ "hits": {
+ "target": "com.meilisearch.api#SimilarPostResponseHitsList",
+ "traits": {
+ "smithy.api#documentation": "Results of the query",
+ "smithy.api#required": {}
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Document ID that was used as reference",
+ "smithy.api#required": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Processing time of the query in milliseconds",
+ "smithy.api#required": {}
+ }
+ },
+ "performanceDetails": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Performance details of the query"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#SimilarPost": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SimilarPostRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SimilarPostResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/indexes/{index_uid}/similar",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get similar documents with POST\n\nRetrieve documents similar to a reference document identified by its id.\n\n> Useful for “more like this” or recommendations."
+ }
+ },
+ "com.meilisearch.api#SizeFormat": {
+ "type": "enum",
+ "members": {
+ "HUMAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "human"
+ }
+ },
+ "RAW": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "raw"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetIndexStatsRequest": {
+ "type": "structure",
+ "members": {
+ "index_uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Unique identifier of the index."
+ }
+ },
+ "showInternalDatabaseSizes": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showInternalDatabaseSizes",
+ "smithy.api#documentation": "If `true`, adds `internalDatabaseSizes` to the response."
+ }
+ },
+ "sizeFormat": {
+ "target": "com.meilisearch.api#SizeFormat",
+ "traits": {
+ "smithy.api#httpQuery": "sizeFormat",
+ "smithy.api#documentation": "Specify how to format the sizes:\n\n- `\"raw\"` (default): format sizes as a number of bytes\n- `\"human\"`: format sizes as a human-readable string with an appropriate unit."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#IndexStats": {
+ "type": "structure",
+ "members": {
+ "numberOfDocuments": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents in the index",
+ "smithy.api#required": {}
+ }
+ },
+ "indexSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Size of the index' DB, in bytes.",
+ "smithy.api#required": {}
+ }
+ },
+ "usedIndexSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Size of the used pages of the index' DB, in bytes.",
+ "smithy.api#required": {}
+ }
+ },
+ "rawDocumentDbSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Size of the documents database, in bytes.",
+ "smithy.api#required": {}
+ }
+ },
+ "avgDocumentSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Average size of a document in the documents database.",
+ "smithy.api#required": {}
+ }
+ },
+ "isIndexing": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether or not the index is currently ingesting document",
+ "smithy.api#required": {}
+ }
+ },
+ "internalDatabaseSizes": {
+ "target": "com.meilisearch.api#IndexStatsInternalDatabaseSizesMap",
+ "traits": {
+ "smithy.api#documentation": "Size of all the internal databases for the index.\n\nDatabase names can change from version to version."
+ }
+ },
+ "numberOfEmbeddings": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of embeddings in the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "numberOfEmbeddedDocuments": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of embedded documents in the index",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "fieldDistribution": {
+ "target": "com.meilisearch.api#IndexStatsFieldDistributionMap",
+ "traits": {
+ "smithy.api#documentation": "Association of every field name with the number of times it occurs in\nthe documents.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Stats of an `Index`, as known to the `stats` route."
+ }
+ },
+ "com.meilisearch.api#Size": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "smithy.api#Integer"
+ },
+ "Case1": {
+ "target": "smithy.api#String"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#IndexStatsInternalDatabaseSizesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Size"
+ },
+ "traits": {
+ "smithy.api#documentation": "Size of all the internal databases for the index.\n\nDatabase names can change from version to version."
+ }
+ },
+ "com.meilisearch.api#IndexStatsFieldDistributionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {
+ "smithy.api#documentation": "Association of every field name with the number of times it occurs in\nthe documents."
+ }
+ },
+ "com.meilisearch.api#GetIndexStats": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetIndexStatsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#IndexStats"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/indexes/{index_uid}/stats",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get stats of index\n\nReturn statistics for a single index: document count, database size, indexing status, and field distribution."
+ }
+ },
+ "com.meilisearch.api#ListApiKeysRequest": {
+ "type": "structure",
+ "members": {
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "offset",
+ "smithy.api#documentation": "Number of keys to skip. Use with `limit` for pagination. Defaults to 0."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of keys to return. Use with `offset` for pagination. Defaults to 20."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PaginationViewKeyView": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#PaginationViewKeyViewResultsList",
+ "traits": {
+ "smithy.api#documentation": "Items for the current page.",
+ "smithy.api#required": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of items skipped.",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of items returned.",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of items matching the query.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#Action": {
+ "type": "enum",
+ "members": {
+ "VALUE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "*"
+ }
+ },
+ "SEARCH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "search"
+ }
+ },
+ "DOCUMENTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documents.*"
+ }
+ },
+ "DOCUMENTS_ADD": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documents.add"
+ }
+ },
+ "DOCUMENTS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documents.get"
+ }
+ },
+ "DOCUMENTS_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documents.delete"
+ }
+ },
+ "INDEXES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.*"
+ }
+ },
+ "INDEXES_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.create"
+ }
+ },
+ "INDEXES_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.get"
+ }
+ },
+ "INDEXES_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.update"
+ }
+ },
+ "INDEXES_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.delete"
+ }
+ },
+ "INDEXES_SWAP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.swap"
+ }
+ },
+ "TASKS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tasks.*"
+ }
+ },
+ "TASKS_CANCEL": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tasks.cancel"
+ }
+ },
+ "TASKS_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tasks.delete"
+ }
+ },
+ "TASKS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tasks.get"
+ }
+ },
+ "SETTINGS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "settings.*"
+ }
+ },
+ "SETTINGS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "settings.get"
+ }
+ },
+ "SETTINGS_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "settings.update"
+ }
+ },
+ "STATS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "stats.*"
+ }
+ },
+ "STATS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "stats.get"
+ }
+ },
+ "METRICS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "metrics.*"
+ }
+ },
+ "METRICS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "metrics.get"
+ }
+ },
+ "DUMPS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dumps.*"
+ }
+ },
+ "DUMPS_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dumps.create"
+ }
+ },
+ "SNAPSHOTS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "snapshots.*"
+ }
+ },
+ "SNAPSHOTS_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "snapshots.create"
+ }
+ },
+ "VERSION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "version"
+ }
+ },
+ "KEYS_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "keys.create"
+ }
+ },
+ "KEYS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "keys.get"
+ }
+ },
+ "KEYS_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "keys.update"
+ }
+ },
+ "KEYS_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "keys.delete"
+ }
+ },
+ "EXPERIMENTAL_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "experimental.get"
+ }
+ },
+ "EXPERIMENTAL_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "experimental.update"
+ }
+ },
+ "EXPORT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "export"
+ }
+ },
+ "NETWORK_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "network.get"
+ }
+ },
+ "NETWORK_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "network.update"
+ }
+ },
+ "CHATCOMPLETIONS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chatCompletions"
+ }
+ },
+ "CHATS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chats.*"
+ }
+ },
+ "CHATS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chats.get"
+ }
+ },
+ "CHATS_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chats.delete"
+ }
+ },
+ "CHATSSETTINGS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chatsSettings.*"
+ }
+ },
+ "CHATSSETTINGS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chatsSettings.get"
+ }
+ },
+ "CHATSSETTINGS_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chatsSettings.update"
+ }
+ },
+ "GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "*.get"
+ }
+ },
+ "WEBHOOKS_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhooks.get"
+ }
+ },
+ "WEBHOOKS_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhooks.update"
+ }
+ },
+ "WEBHOOKS_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhooks.delete"
+ }
+ },
+ "WEBHOOKS_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhooks.create"
+ }
+ },
+ "WEBHOOKS": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "webhooks.*"
+ }
+ },
+ "INDEXES_COMPACT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexes.compact"
+ }
+ },
+ "FIELDS_POST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "fields.post"
+ }
+ },
+ "TASKS_COMPACT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "tasks.compact"
+ }
+ },
+ "DYNAMICSEARCHRULES_GET": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamicSearchRules.get"
+ }
+ },
+ "DYNAMICSEARCHRULES_CREATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamicSearchRules.create"
+ }
+ },
+ "DYNAMICSEARCHRULES_UPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamicSearchRules.update"
+ }
+ },
+ "DYNAMICSEARCHRULES_DELETE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamicSearchRules.delete"
+ }
+ },
+ "DYNAMICSEARCHRULES": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dynamicSearchRules.*"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#PaginationViewKeyViewResultsItemActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Action"
+ },
+ "traits": {
+ "smithy.api#documentation": "The list of actions (permissions) this key is allowed to perform.\nExamples include `documents.add`, `search`, `indexes.create`,\n`settings.update`, etc. Use `*` to grant all permissions."
+ }
+ },
+ "com.meilisearch.api#PaginationViewKeyViewResultsItemIndexesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "The list of index UIDs this key can access. Use `*` to grant access to\nall indexes, including future ones. Patterns are also supported, e.g.,\n`movies_*` matches any index starting with \"movies_\"."
+ }
+ },
+ "com.meilisearch.api#PaginationViewKeyViewResultsItem": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A human-readable name for the API key. Use this to identify the purpose\nof each key, such as \"Frontend Search Key\" or \"Admin Key for CI/CD\".\nThis is optional and can be `null`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A longer description explaining the purpose or usage of this API key.\nUseful for documenting why the key was created and how it should be\nused. This is optional and can be `null`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "key": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The actual API key string to use in the `Authorization: Bearer `\nheader when making requests to Meilisearch. Keep this value secret and\nnever expose it in client-side code.",
+ "smithy.api#required": {}
+ }
+ },
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The unique identifier (UUID) for this API key. Use this to update or\ndelete the key. The UID remains constant even if the key's name or\ndescription changes.",
+ "smithy.api#required": {}
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#PaginationViewKeyViewResultsItemActionsList",
+ "traits": {
+ "smithy.api#documentation": "The list of actions (permissions) this key is allowed to perform.\nExamples include `documents.add`, `search`, `indexes.create`,\n`settings.update`, etc. Use `*` to grant all permissions.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexes": {
+ "target": "com.meilisearch.api#PaginationViewKeyViewResultsItemIndexesList",
+ "traits": {
+ "smithy.api#documentation": "The list of index UIDs this key can access. Use `*` to grant access to\nall indexes, including future ones. Patterns are also supported, e.g.,\n`movies_*` matches any index starting with \"movies_\".",
+ "smithy.api#required": {}
+ }
+ },
+ "expiresAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The expiration date and time of the key in RFC 3339 format. After this\ntime, the key will no longer be valid for authentication. Set to `null`\nfor keys that never expire.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "createdAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The date and time when this API key was created, formatted as an\nRFC 3339 date-time string. This is automatically set by Meilisearch\nand cannot be modified.",
+ "smithy.api#required": {}
+ }
+ },
+ "updatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The date and time when this API key was last modified, formatted as an\nRFC 3339 date-time string. This is automatically updated by Meilisearch\nwhen the key's name or description changes.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents an API key used for authenticating requests to Meilisearch.\nEach key has specific permissions defined by its actions and can be scoped\nto particular indexes. Keys provide fine-grained access control for your\nMeilisearch instance."
+ }
+ },
+ "com.meilisearch.api#PaginationViewKeyViewResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#PaginationViewKeyViewResultsItem"
+ },
+ "traits": {
+ "smithy.api#documentation": "Items for the current page."
+ }
+ },
+ "com.meilisearch.api#ListApiKeys": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#ListApiKeysRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PaginationViewKeyView"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/keys",
+ "code": 200
+ },
+ "smithy.api#documentation": "List API keys\n\nReturn all API keys configured on the instance. Results are paginated and can be filtered by offset and limit. The key value itself is never returned after creation.\n\n**Note:** Expired keys are included in the response but deleted keys are not.\nKeys are returned in descending order of creation date."
+ }
+ },
+ "com.meilisearch.api#CreateApiKeyRequestActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Action"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of actions permitted for the key. `[\"*\"]` for all actions. The\n`*` character can be used as a wildcard when located at the last\nposition. e.g. `documents.*` to authorize access on all documents\nendpoints.\n\nValid actions include: `search`, `documents.add`,\n`documents.get`, `documents.delete`, `indexes.create`, `indexes.get`,\n`indexes.update`, `indexes.delete`, `indexes.swap`, `tasks.get`,\n`tasks.cancel`, `tasks.delete`, `settings.get`, `settings.update`,\n`stats.get`, `dumps.create`, `snapshots.create`, `version`, `keys.get`,\n`keys.create`, `keys.update`, `keys.delete`. Use `*` to grant all actions."
+ }
+ },
+ "com.meilisearch.api#CreateApiKeyRequestIndexesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "A list of accessible indexes permitted for the key. `[\"*\"]` for all\nindexes. The `*` character can be used as a wildcard when located at\nthe last position. e.g. `products_*` to allow access to all indexes\nwhose names start with `products_`."
+ }
+ },
+ "com.meilisearch.api#CreateApiKeyRequest": {
+ "type": "structure",
+ "members": {
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A description for the key. `null` if empty.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A human-readable name for the key. `null` if empty.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A uuid v4 to identify the API Key. If not specified, it's generated by Meilisearch.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#CreateApiKeyRequestActionsList",
+ "traits": {
+ "smithy.api#documentation": "A list of actions permitted for the key. `[\"*\"]` for all actions. The\n`*` character can be used as a wildcard when located at the last\nposition. e.g. `documents.*` to authorize access on all documents\nendpoints.\n\nValid actions include: `search`, `documents.add`,\n`documents.get`, `documents.delete`, `indexes.create`, `indexes.get`,\n`indexes.update`, `indexes.delete`, `indexes.swap`, `tasks.get`,\n`tasks.cancel`, `tasks.delete`, `settings.get`, `settings.update`,\n`stats.get`, `dumps.create`, `snapshots.create`, `version`, `keys.get`,\n`keys.create`, `keys.update`, `keys.delete`. Use `*` to grant all actions.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexes": {
+ "target": "com.meilisearch.api#CreateApiKeyRequestIndexesList",
+ "traits": {
+ "smithy.api#documentation": "A list of accessible indexes permitted for the key. `[\"*\"]` for all\nindexes. The `*` character can be used as a wildcard when located at\nthe last position. e.g. `products_*` to allow access to all indexes\nwhose names start with `products_`.",
+ "smithy.api#required": {}
+ }
+ },
+ "expiresAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Represent the expiration date and time as RFC 3339 format. `null`\nequals to no expiration time. Set to `null` to create a key that never\nexpires. Once a key is past its expiry date, using it returns an error.",
+ "smithy.api#required": {},
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#KeyView": {
+ "type": "structure",
+ "members": {
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A human-readable name for the API key. Use this to identify the purpose\nof each key, such as \"Frontend Search Key\" or \"Admin Key for CI/CD\".\nThis is optional and can be `null`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A longer description explaining the purpose or usage of this API key.\nUseful for documenting why the key was created and how it should be\nused. This is optional and can be `null`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "key": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The actual API key string to use in the `Authorization: Bearer `\nheader when making requests to Meilisearch. Keep this value secret and\nnever expose it in client-side code.",
+ "smithy.api#required": {}
+ }
+ },
+ "uid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The unique identifier (UUID) for this API key. Use this to update or\ndelete the key. The UID remains constant even if the key's name or\ndescription changes.",
+ "smithy.api#required": {}
+ }
+ },
+ "actions": {
+ "target": "com.meilisearch.api#KeyViewActionsList",
+ "traits": {
+ "smithy.api#documentation": "The list of actions (permissions) this key is allowed to perform.\nExamples include `documents.add`, `search`, `indexes.create`,\n`settings.update`, etc. Use `*` to grant all permissions.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexes": {
+ "target": "com.meilisearch.api#KeyViewIndexesList",
+ "traits": {
+ "smithy.api#documentation": "The list of index UIDs this key can access. Use `*` to grant access to\nall indexes, including future ones. Patterns are also supported, e.g.,\n`movies_*` matches any index starting with \"movies_\".",
+ "smithy.api#required": {}
+ }
+ },
+ "expiresAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The expiration date and time of the key in RFC 3339 format. After this\ntime, the key will no longer be valid for authentication. Set to `null`\nfor keys that never expire.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "createdAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The date and time when this API key was created, formatted as an\nRFC 3339 date-time string. This is automatically set by Meilisearch\nand cannot be modified.",
+ "smithy.api#required": {}
+ }
+ },
+ "updatedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The date and time when this API key was last modified, formatted as an\nRFC 3339 date-time string. This is automatically updated by Meilisearch\nwhen the key's name or description changes.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents an API key used for authenticating requests to Meilisearch.\nEach key has specific permissions defined by its actions and can be scoped\nto particular indexes. Keys provide fine-grained access control for your\nMeilisearch instance."
+ }
+ },
+ "com.meilisearch.api#KeyViewActionsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Action"
+ },
+ "traits": {
+ "smithy.api#documentation": "The list of actions (permissions) this key is allowed to perform.\nExamples include `documents.add`, `search`, `indexes.create`,\n`settings.update`, etc. Use `*` to grant all permissions."
+ }
+ },
+ "com.meilisearch.api#KeyViewIndexesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "The list of index UIDs this key can access. Use `*` to grant access to\nall indexes, including future ones. Patterns are also supported, e.g.,\n`movies_*` matches any index starting with \"movies_\"."
+ }
+ },
+ "com.meilisearch.api#CreateApiKey": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#CreateApiKeyRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#KeyView"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/keys",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create API key\n\nCreate a new API key with the specified name, description, actions, and index scopes. The key value is returned only once at creation time; store it securely.\n\n**Required fields:** `actions`, `indexes`, `expiresAt`.\n**Optional fields:** `name`, `description`, `uid`.\n\nSet `expiresAt` to `null` to create a key that never expires.\nUse `\"*\"` in the `actions` array to grant all permissions (not recommended for production).\nUse `[\"*\"]` in the `indexes` array to grant access to all indexes."
+ }
+ },
+ "com.meilisearch.api#GetApiKeyRequest": {
+ "type": "structure",
+ "members": {
+ "key": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The `uid` or `key` field of an existing API key."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetApiKey": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetApiKeyRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#KeyView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/keys/{key}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get API key\n\nRetrieve a single API key by its `uid` or by its `key` value."
+ }
+ },
+ "com.meilisearch.api#PatchApiKeyRequest": {
+ "type": "structure",
+ "members": {
+ "key": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The `uid` or `key` field of an existing API key."
+ }
+ },
+ "description": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A new description for the API key. Pass `null` to remove the existing\ndescription. Useful for documenting the purpose or usage of the key.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "name": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "A new human-readable name for the API key. Pass `null` to remove the\nexisting name. Use this to identify keys by purpose, such as\n\"Production Search Key\" or \"CI/CD Indexing Key\".",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchApiKey": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchApiKeyRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#KeyView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/keys/{key}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update API key\n\nUpdate the name and description of an API key.\n\nUpdates are partial: only the fields you send are changed, and any fields not present in the payload remain unchanged.\n\n**Note:** Only `name` and `description` can be updated. The fields `actions`, `indexes`,\n`expiresAt`, and `uid` cannot be modified after key creation."
+ }
+ },
+ "com.meilisearch.api#DeleteApiKeyRequest": {
+ "type": "structure",
+ "members": {
+ "key": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The `uid` or `key` field of an existing API key."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteApiKey": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteApiKeyRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/keys/{key}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete API key\n\nPermanently delete the specified API key. The key will no longer be valid for authentication."
+ }
+ },
+ "com.meilisearch.api#UpdateStderrTargetRequest": {
+ "type": "structure",
+ "members": {
+ "target": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Log targets to filter. Format: code_part=log_level (e.g.,\nmilli=trace,actix_web=off)"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#UpdateStderrTarget": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#UpdateStderrTargetRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/logs/stderr",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update target of the console logs\n\nConfigure at runtime the level of the console logs written to stderr (e.g. debug, info, warn, error)."
+ }
+ },
+ "com.meilisearch.api#LogMode": {
+ "type": "enum",
+ "members": {
+ "HUMAN": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "human"
+ }
+ },
+ "JSON": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "json"
+ }
+ },
+ "PROFILE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "profile"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Format for log output"
+ }
+ },
+ "com.meilisearch.api#GetLogsRequest": {
+ "type": "structure",
+ "members": {
+ "target": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Log targets to filter. Format: code_part=log_level (e.g.,\nmilli=trace,actix_web=off)"
+ }
+ },
+ "mode": {
+ "target": "com.meilisearch.api#LogMode"
+ },
+ "profileMemory": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Enable memory profiling (only useful with profile mode, significantly\nslows down the engine)"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetLogsResponse": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#rawResponse": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetLogs": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetLogsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetLogsResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/logs/stream",
+ "code": 200
+ },
+ "smithy.api#documentation": "Retrieve logs\n\nStream logs over HTTP. The format of the logs depends on the configuration specified in the payload. The logs are sent as multi-part, and the stream never stops, so ensure your client can handle a long-lived connection. To stop receiving logs, call the `DELETE /logs/stream` route.\n\nOnly one client can listen at a time. An error is returned if you call this route while it is already in use by another client."
+ }
+ },
+ "com.meilisearch.api#CancelLogs": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/logs/stream",
+ "code": 200
+ },
+ "smithy.api#documentation": "Stop retrieving logs\n\nCall this route to make the engine stop sending logs to the client that opened the `POST /logs/stream` connection."
+ }
+ },
+ "com.meilisearch.api#GetMetrics": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/metrics",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get Prometheus metrics\n\nReturn metrics for the engine in Prometheus format. This is an [experimental feature](https://www.meilisearch.com/docs/learn/experimental/overview) and must be enabled before use."
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndex": {
+ "type": "structure",
+ "members": {
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Index unique identifier",
+ "smithy.api#required": {}
+ }
+ },
+ "q": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Query string",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents to skip",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Request a specific page of results",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned for a page",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "attributesToRetrieve": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexAttributesToRetrieveList",
+ "traits": {
+ "smithy.api#documentation": "Attributes to display in the returned documents",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "attributesToCrop": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexAttributesToCropList",
+ "traits": {
+ "smithy.api#documentation": "Attributes whose values have to be cropped",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "cropLength": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum length of cropped value in words"
+ }
+ },
+ "cropMarker": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String marking crop boundaries"
+ }
+ },
+ "attributesToHighlight": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexAttributesToHighlightList",
+ "traits": {
+ "smithy.api#documentation": "Highlight matching terms contained in an attribute",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "highlightPreTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String inserted at the start of a highlighted term"
+ }
+ },
+ "highlightPostTag": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "String inserted at the end of a highlighted term"
+ }
+ },
+ "showMatchesPosition": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Return matching terms location"
+ }
+ },
+ "filter": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Filter queries by an attribute's value"
+ }
+ },
+ "sort": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexSortList",
+ "traits": {
+ "smithy.api#documentation": "Sort search results by an attribute's value",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Restrict search to documents with unique values of specified\nattribute",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facets": {
+ "target": "com.meilisearch.api#AttributePatterns",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "matchingStrategy": {
+ "target": "com.meilisearch.api#MatchingStrategy"
+ },
+ "attributesToSearchOn": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexAttributesToSearchOnList",
+ "traits": {
+ "smithy.api#documentation": "Restrict search to the specified attributes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "rankingScoreThreshold": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "Exclude results below the specified ranking score",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "locales": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexLocalesList",
+ "traits": {
+ "smithy.api#documentation": "Languages to use for query tokenization",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "hybrid": {
+ "target": "com.meilisearch.api#HybridQuery",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "vector": {
+ "target": "com.meilisearch.api#SearchQueryWithIndexVectorList",
+ "traits": {
+ "smithy.api#documentation": "Search using a custom query vector",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "retrieveVectors": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Return document and query vector data"
+ }
+ },
+ "media": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Perform AI-powered search queries with multimodal content"
+ }
+ },
+ "personalize": {
+ "target": "com.meilisearch.api#Personalize",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "useNetwork": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "showRankingScore": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Display the global ranking score of a document"
+ }
+ },
+ "showRankingScoreDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Adds a detailed global ranking score field"
+ }
+ },
+ "showPerformanceDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Adds a detailed performance details field",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "federationOptions": {
+ "target": "com.meilisearch.api#FederationOptions",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A `SearchQuery` + an index UID and optional FederationOptions."
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexAttributesToRetrieveList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes to display in the returned documents"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexAttributesToCropList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Attributes whose values have to be cropped"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexAttributesToHighlightList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Highlight matching terms contained in an attribute"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexSortList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Sort search results by an attribute's value"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexAttributesToSearchOnList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Restrict search to the specified attributes"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexLocalesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Locale"
+ },
+ "traits": {
+ "smithy.api#documentation": "Languages to use for query tokenization"
+ }
+ },
+ "com.meilisearch.api#SearchQueryWithIndexVectorList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {
+ "smithy.api#documentation": "Search using a custom query vector"
+ }
+ },
+ "com.meilisearch.api#FederationOptions": {
+ "type": "structure",
+ "members": {
+ "weight": {
+ "target": "smithy.api#Double",
+ "traits": {
+ "smithy.api#documentation": "A multiplicative factor applied to the ranking score for hits from this query.\n\nValues less than 1.0 make hits from this query less likely to appear in final results; values greater than 1.0 make them more likely.\n\nMust be a positive number. Default: `1.0`."
+ }
+ },
+ "remote": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Remote server to send this query to",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "queryPosition": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Position of this query in the list of queries",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Options for federated multi-search queries"
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostRequestQueriesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchQueryWithIndex"
+ },
+ "traits": {
+ "smithy.api#documentation": "An array of search queries to execute. Each query can target a\ndifferent index and have its own parameters. When `federation` is\n`null`, results are returned separately for each query. When\n`federation` is set, results are merged.\n\nEach query object must include `indexUid` to specify which index to search."
+ }
+ },
+ "com.meilisearch.api#Federation": {
+ "type": "structure",
+ "members": {
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of results to return across all queries"
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results to skip"
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetsByIndex": {
+ "target": "com.meilisearch.api#FederationFacetsByIndexMap",
+ "traits": {
+ "smithy.api#documentation": "Facets to retrieve per index"
+ }
+ },
+ "mergeFacets": {
+ "target": "com.meilisearch.api#MergeFacets",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "distinct": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Restrict search to documents with unique values of the specified attribute across all queries.\n\n1. This applies across all queries in the request, regardless of index or remote of origin.\n2. This overrides the index-level distinct attribute.\n3. This requires that the passed field can be set as distinct in all the participating indexes.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "showPerformanceDetails": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether to include performance details in the response"
+ }
+ },
+ "personalize": {
+ "target": "com.meilisearch.api#Personalize",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Configuration for federated multi-search"
+ }
+ },
+ "com.meilisearch.api#FederationFacetsByIndexMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#AttributePatterns"
+ },
+ "traits": {
+ "smithy.api#documentation": "Facets to retrieve per index"
+ }
+ },
+ "com.meilisearch.api#MergeFacets": {
+ "type": "structure",
+ "members": {
+ "maxValuesPerFacet": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The maximum number of facet values to return for each facet after\nmerging. Values from all indexes are combined and sorted before\ntruncation. If not specified, uses the default limit from the index\nsettings.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Options for merging facets from multiple indexes in federated search.\nWhen multiple indexes are queried, this controls how their facet values\nare combined into a single facet distribution."
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostRequest": {
+ "type": "structure",
+ "members": {
+ "queries": {
+ "target": "com.meilisearch.api#MultiSearchWithPostRequestQueriesList",
+ "traits": {
+ "smithy.api#documentation": "An array of search queries to execute. Each query can target a\ndifferent index and have its own parameters. When `federation` is\n`null`, results are returned separately for each query. When\n`federation` is set, results are merged.\n\nEach query object must include `indexUid` to specify which index to search.",
+ "smithy.api#required": {}
+ }
+ },
+ "federation": {
+ "target": "com.meilisearch.api#Federation",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseHitsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchHit"
+ },
+ "traits": {
+ "smithy.api#documentation": "Combined search results from all queries"
+ }
+ },
+ "com.meilisearch.api#Vec": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Double"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseQueryVectorsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Vec"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseFacetDistributionValueMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseFacetDistributionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseFacetDistributionValueMap"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseFacetStatsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetStats"
+ },
+ "traits": {
+ "smithy.api#documentation": "Merged facet statistics across all indexes"
+ }
+ },
+ "com.meilisearch.api#FederatedFacets": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ComputedFacets"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ComputedFacets": {
+ "type": "structure",
+ "members": {
+ "distribution": {
+ "target": "com.meilisearch.api#ComputedFacetsDistributionMap",
+ "traits": {
+ "smithy.api#documentation": "Count of documents for each facet value",
+ "smithy.api#required": {}
+ }
+ },
+ "stats": {
+ "target": "com.meilisearch.api#ComputedFacetsStatsMap",
+ "traits": {
+ "smithy.api#documentation": "Numeric statistics for each facet",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Computed facet data from a search"
+ }
+ },
+ "com.meilisearch.api#ComputedFacetsDistributionValueMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#ComputedFacetsDistributionMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ComputedFacetsDistributionValueMap"
+ },
+ "traits": {
+ "smithy.api#documentation": "Count of documents for each facet value"
+ }
+ },
+ "com.meilisearch.api#ComputedFacetsStatsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#FacetStats"
+ },
+ "traits": {
+ "smithy.api#documentation": "Numeric statistics for each facet"
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseMetadataList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SearchMetadata"
+ },
+ "traits": {
+ "smithy.api#documentation": "Metadata for each query"
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponseRemoteErrorsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#ResponseError"
+ },
+ "traits": {
+ "smithy.api#documentation": "Errors from remote servers"
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPostResponse": {
+ "type": "structure",
+ "members": {
+ "hitsPerPage": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of results per page."
+ }
+ },
+ "page": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Current page index (1-based)."
+ }
+ },
+ "totalPages": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of result pages."
+ }
+ },
+ "totalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Exhaustive total number of matching documents."
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of documents returned."
+ }
+ },
+ "offset": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents skipped."
+ }
+ },
+ "estimatedTotalHits": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance."
+ }
+ },
+ "hits": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseHitsList",
+ "traits": {
+ "smithy.api#documentation": "Combined search results from all queries",
+ "smithy.api#required": {}
+ }
+ },
+ "queryVectors": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseQueryVectorsMap",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "processingTimeMs": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total processing time in milliseconds",
+ "smithy.api#required": {}
+ }
+ },
+ "facetDistribution": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseFacetDistributionMap",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetStats": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseFacetStatsMap",
+ "traits": {
+ "smithy.api#documentation": "Merged facet statistics across all indexes",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "facetsByIndex": {
+ "target": "com.meilisearch.api#FederatedFacets",
+ "traits": {
+ "smithy.api#documentation": "Facets grouped by index"
+ }
+ },
+ "requestUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier for the request",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "metadata": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseMetadataList",
+ "traits": {
+ "smithy.api#documentation": "Metadata for each query",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "remoteErrors": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponseRemoteErrorsMap",
+ "traits": {
+ "smithy.api#documentation": "Errors from remote servers",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "semanticHitCount": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "performanceDetails": {
+ "target": "smithy.api#Document"
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#MultiSearchWithPost": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#MultiSearchWithPostRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#MultiSearchWithPostResponse"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/multi-search",
+ "code": 200
+ },
+ "smithy.api#documentation": "Perform a multi-search\n\nRun multiple search queries in a single API request.\n\nEach query can target a different index, so you can search across several indexes at once and get one combined response.\n\n**Warning:** If Meilisearch encounters an error processing any query in the request, it immediately\nstops and returns an error message for the first error encountered. Partial results are not returned."
+ }
+ },
+ "com.meilisearch.api#Network": {
+ "type": "structure",
+ "members": {
+ "remotes": {
+ "target": "com.meilisearch.api#NetworkRemotesMap",
+ "traits": {
+ "smithy.api#documentation": "Map of remote instance names to their configurations\n\n- Pass `null` as a value for a remote to remove it from the configuration.\n- Removing a remote will also remove it from all shards.\n- Remotes that don't appear in this list will be unmodified by the network call.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "shards": {
+ "target": "com.meilisearch.api#NetworkShardsMap",
+ "traits": {
+ "smithy.api#documentation": "Map of shard names to their configurations.\n\n- Pass `null` as a value for a shard to remove it from the configuration.\n- Shards that don't appear in this list will be unmodified by the network call.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "previousShards": {
+ "target": "com.meilisearch.api#NetworkPreviousShardsMap",
+ "traits": {
+ "smithy.api#documentation": "Previous shard configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "self": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of this instance in the network",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "leader": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the leader instance in the network",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "previousRemotes": {
+ "target": "com.meilisearch.api#NetworkPreviousRemotesMap",
+ "traits": {
+ "smithy.api#documentation": "Previous remote configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Network topology configuration for distributed Meilisearch"
+ }
+ },
+ "com.meilisearch.api#Remote": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL of the remote instance\n\n- If the URL of the remote instance is resolving to a non-global IP, 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).",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "searchApiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "API key for search operations on this remote",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "writeApiKey": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "API key for write operations on this remote",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Configuration for a remote Meilisearch instance"
+ }
+ },
+ "com.meilisearch.api#NetworkRemotesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Remote"
+ },
+ "traits": {
+ "smithy.api#documentation": "Map of remote instance names to their configurations\n\n- Pass `null` as a value for a remote to remove it from the configuration.\n- Removing a remote will also remove it from all shards.\n- Remotes that don't appear in this list will be unmodified by the network call."
+ }
+ },
+ "com.meilisearch.api#Shard": {
+ "type": "structure",
+ "members": {
+ "remotes": {
+ "target": "com.meilisearch.api#ShardRemotesList",
+ "traits": {
+ "smithy.api#documentation": "List of remotes that own this shard.\n\n- The remotes must be part of the network's configuration\n- Setting this to a non-`null` value will replace all existing remotes for this shard.\n- `addRemotes` and `removeRemotes` are applied after `remotes` if multiple options are present.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "addRemotes": {
+ "target": "com.meilisearch.api#ShardAddRemotesList",
+ "traits": {
+ "smithy.api#documentation": "Remotes to add to the list of owners of this shard.\n\n- The remotes must be part of the network's configuration\n- Setting this to non-`null` will append the listed remotes to the list of owners of this shard.\n- `remotes` is applied before `addRemotes`\n- `removeRemotes` is applied after `addRemotes`",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "removeRemotes": {
+ "target": "com.meilisearch.api#ShardRemoveRemotesList",
+ "traits": {
+ "smithy.api#documentation": "Remotes to remove from the list of owners of this shard.\n\n- The remotes may or may not be part of the network's configuration\n- Setting this to non-`null` will remove the listed remotes from the list of owners of this shard.\n- `remotes` and `addRemotes` are applied before `removeRemotes`\n- Remotes removed from the configuration are automatically removed from all shards and it is not necessary\n to explicitly pass them as `removeRemotes`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Configuration for a named shard of the network\n\nDocuments are distributed among the various declared shards.\nRemotes own shards, meaning they own the documents that belong to these shards."
+ }
+ },
+ "com.meilisearch.api#ShardRemotesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "List of remotes that own this shard.\n\n- The remotes must be part of the network's configuration\n- Setting this to a non-`null` value will replace all existing remotes for this shard.\n- `addRemotes` and `removeRemotes` are applied after `remotes` if multiple options are present."
+ }
+ },
+ "com.meilisearch.api#ShardAddRemotesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Remotes to add to the list of owners of this shard.\n\n- The remotes must be part of the network's configuration\n- Setting this to non-`null` will append the listed remotes to the list of owners of this shard.\n- `remotes` is applied before `addRemotes`\n- `removeRemotes` is applied after `addRemotes`"
+ }
+ },
+ "com.meilisearch.api#ShardRemoveRemotesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Remotes to remove from the list of owners of this shard.\n\n- The remotes may or may not be part of the network's configuration\n- Setting this to non-`null` will remove the listed remotes from the list of owners of this shard.\n- `remotes` and `addRemotes` are applied before `removeRemotes`\n- Remotes removed from the configuration are automatically removed from all shards and it is not necessary\n to explicitly pass them as `removeRemotes`."
+ }
+ },
+ "com.meilisearch.api#NetworkShardsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Shard"
+ },
+ "traits": {
+ "smithy.api#documentation": "Map of shard names to their configurations.\n\n- Pass `null` as a value for a shard to remove it from the configuration.\n- Shards that don't appear in this list will be unmodified by the network call."
+ }
+ },
+ "com.meilisearch.api#NetworkPreviousShardsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Shard"
+ },
+ "traits": {
+ "smithy.api#documentation": "Previous shard configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances"
+ }
+ },
+ "com.meilisearch.api#NetworkPreviousRemotesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Remote"
+ },
+ "traits": {
+ "smithy.api#documentation": "Previous remote configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances"
+ }
+ },
+ "com.meilisearch.api#GetNetwork": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#Network"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/network",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get network topology\n\nReturn the list of Meilisearch instances currently known to this node (self and remotes)."
+ }
+ },
+ "com.meilisearch.api#PatchNetworkRequestRemotesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Remote"
+ },
+ "traits": {
+ "smithy.api#documentation": "Map of remote instance names to their configurations\n\n- Pass `null` as a value for a remote to remove it from the configuration.\n- Removing a remote will also remove it from all shards.\n- Remotes that don't appear in this list will be unmodified by the network call."
+ }
+ },
+ "com.meilisearch.api#PatchNetworkRequestShardsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Shard"
+ },
+ "traits": {
+ "smithy.api#documentation": "Map of shard names to their configurations.\n\n- Pass `null` as a value for a shard to remove it from the configuration.\n- Shards that don't appear in this list will be unmodified by the network call."
+ }
+ },
+ "com.meilisearch.api#PatchNetworkRequestPreviousShardsMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Shard"
+ },
+ "traits": {
+ "smithy.api#documentation": "Previous shard configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances"
+ }
+ },
+ "com.meilisearch.api#PatchNetworkRequestPreviousRemotesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#Remote"
+ },
+ "traits": {
+ "smithy.api#documentation": "Previous remote configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances"
+ }
+ },
+ "com.meilisearch.api#PatchNetworkRequest": {
+ "type": "structure",
+ "members": {
+ "remotes": {
+ "target": "com.meilisearch.api#PatchNetworkRequestRemotesMap",
+ "traits": {
+ "smithy.api#documentation": "Map of remote instance names to their configurations\n\n- Pass `null` as a value for a remote to remove it from the configuration.\n- Removing a remote will also remove it from all shards.\n- Remotes that don't appear in this list will be unmodified by the network call.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "shards": {
+ "target": "com.meilisearch.api#PatchNetworkRequestShardsMap",
+ "traits": {
+ "smithy.api#documentation": "Map of shard names to their configurations.\n\n- Pass `null` as a value for a shard to remove it from the configuration.\n- Shards that don't appear in this list will be unmodified by the network call.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "previousShards": {
+ "target": "com.meilisearch.api#PatchNetworkRequestPreviousShardsMap",
+ "traits": {
+ "smithy.api#documentation": "Previous shard configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "self": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of this instance in the network",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "leader": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the leader instance in the network",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "previousRemotes": {
+ "target": "com.meilisearch.api#PatchNetworkRequestPreviousRemotesMap",
+ "traits": {
+ "smithy.api#documentation": "Previous remote configurations\n\nThis field should not be passed by end-users. It is used in internal communications between Meilisearch instances",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchNetwork": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchNetworkRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#Network"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/network",
+ "code": 200
+ },
+ "smithy.api#documentation": "Configure network topology\n\nAdd or remove remote nodes from the network. Changes apply to the current instance’s view of the cluster."
+ }
+ },
+ "com.meilisearch.api#Origin": {
+ "type": "structure",
+ "members": {
+ "remoteName": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The name of the remote Meilisearch instance where this task originated.\nThis corresponds to a remote defined in the network configuration.",
+ "smithy.api#required": {}
+ }
+ },
+ "taskUid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The unique task identifier on the originating remote. This allows\ntracking the same task across different nodes in the network.",
+ "smithy.api#required": {}
+ }
+ },
+ "networkVersion": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The version of the network topology when this task was created. Used to\nensure consistent task routing during network topology changes."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Information about the origin of a task in a distributed Meilisearch\ndeployment. This tracks where a task was originally created before being\nreplicated to other nodes."
+ }
+ },
+ "com.meilisearch.api#Message": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#MessageCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#MessageCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#MessageCase2"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MessageCase0Type": {
+ "type": "enum",
+ "members": {
+ "EXPORTNOINDEXFORREMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "exportNoIndexForRemote"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MessageCase0": {
+ "type": "structure",
+ "members": {
+ "remote": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the remote that will no longer export any document to this instance.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#MessageCase0Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The specified remote will not longer export any document to this instance.\n\nSend this message to remotes that are blocked waiting on the specified remote to export its documents."
+ }
+ },
+ "com.meilisearch.api#MessageCase1Type": {
+ "type": "enum",
+ "members": {
+ "IMPORTFINISHEDFORREMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "importFinishedForRemote"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MessageCase1": {
+ "type": "structure",
+ "members": {
+ "remote": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the remote that finished importing its documents.",
+ "smithy.api#required": {}
+ }
+ },
+ "successful": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the import was successful.\n\nDocuments from shards that no longer belong to remotes are only deleted if all remotes are successful\nimporting their documents.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#MessageCase1Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The specified remote is finished importing its documents.\n\nSend this message to remotes that are blocked waiting on the specified remote to finish importing its documents."
+ }
+ },
+ "com.meilisearch.api#MessageCase2Type": {
+ "type": "enum",
+ "members": {
+ "STATUSCHANGEFORREMOTE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "statusChangeForRemote"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#MessageCase2": {
+ "type": "structure",
+ "members": {
+ "remote": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the remote whose status will be changed.",
+ "smithy.api#required": {}
+ }
+ },
+ "status": {
+ "target": "com.meilisearch.api#Status",
+ "traits": {
+ "smithy.api#documentation": "The new status for the remote.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#MessageCase2Type",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The specified remote will see it's status change.\n\nSend this message to change the accessiblity of a remote."
+ }
+ },
+ "com.meilisearch.api#PostNetworkChangeRequest": {
+ "type": "structure",
+ "members": {
+ "origin": {
+ "target": "com.meilisearch.api#Origin",
+ "traits": {
+ "smithy.api#documentation": "The origin of this message\n\nGet it in the details of the network topology change task that is currently processing.",
+ "smithy.api#required": {}
+ }
+ },
+ "message": {
+ "target": "com.meilisearch.api#Message",
+ "traits": {
+ "smithy.api#documentation": "Message to send to control the network topology change task.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PostNetworkChange": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PostNetworkChangeRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/network/control",
+ "code": 200
+ },
+ "smithy.api#documentation": "Network control\n\nSend messages to control the progress of a network topology change task.\n\nThe route is mostly used internally when sending a PATCH to the network, but is accessible for manual control as well."
+ }
+ },
+ "com.meilisearch.api#RenderQueryTemplate": {
+ "type": "structure",
+ "members": {
+ "kind": {
+ "target": "com.meilisearch.api#RenderQueryTemplateKind",
+ "traits": {
+ "smithy.api#documentation": "Kind of template or fragment to fetch.\n\nDetermines which other parameters are allowed and mandatory.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "embedder": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Embedder to fetch the template or fragment from.\n\n- Mandatory for `kind`s: `documentTemplate`, `chatDocumentTemplate`, `indexingFragment` and `searchFragment`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "fragment": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Name of the fragment to fetch.\n\n- Mandatory for `kind`s: `indexingFragment` and `searchFragment`.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "inline": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Inline value of the template or fragment.\n\n- Mandatory for `kind`s: `inlineDocumentTemplate` and `inlineFragment`."
+ }
+ },
+ "documentTemplateMaxBytes": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "If present, truncate document template rendering to the specified number of bytes.\n\n- Available for `kind`s: `documentTemplate`, `inlineDocumentTemplate` and `chatDocumentTemplate`\n- If present for `documentTemplate` overrides the setting of the index.\n- If missing for `documentTemplate`, the setting of the index is used.\n- If missing for `inlineDocumentTemplate`, the default value of 400 bytes is used.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RenderQueryTemplateKind": {
+ "type": "enum",
+ "members": {
+ "DOCUMENTTEMPLATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documentTemplate"
+ }
+ },
+ "CHATDOCUMENTTEMPLATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "chatDocumentTemplate"
+ }
+ },
+ "INDEXINGFRAGMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexingFragment"
+ }
+ },
+ "SEARCHFRAGMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "searchFragment"
+ }
+ },
+ "INLINEDOCUMENTTEMPLATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "inlineDocumentTemplate"
+ }
+ },
+ "INLINEFRAGMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "inlineFragment"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RenderQueryInput": {
+ "type": "structure",
+ "members": {
+ "kind": {
+ "target": "com.meilisearch.api#RenderQueryInputKind",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "id": {
+ "target": "smithy.api#String",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "inline": {
+ "target": "smithy.api#Document"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RenderQueryInputKind": {
+ "type": "enum",
+ "members": {
+ "INDEXDOCUMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexDocument"
+ }
+ },
+ "INLINEDOCUMENT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "inlineDocument"
+ }
+ },
+ "INLINESEARCH": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "inlineSearch"
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RenderPostRequest": {
+ "type": "structure",
+ "members": {
+ "template": {
+ "target": "com.meilisearch.api#RenderQueryTemplate",
+ "traits": {
+ "smithy.api#documentation": "Template/fragment to fetch for rendering.\n\nUse its `kind` parameter to determine the type of template or fragment to fetch.",
+ "smithy.api#required": {}
+ }
+ },
+ "input": {
+ "target": "com.meilisearch.api#RenderQueryInput",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#RenderResult": {
+ "type": "structure",
+ "members": {
+ "template": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "**Un**rendered template or fragment, fetched in index or echoed back from inline template in request.",
+ "smithy.api#required": {}
+ }
+ },
+ "rendered": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Result of rendering the template by injecting the `input` to the template.\n\n`null` if `input` was `null` or missing in the request."
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#RenderPost": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#RenderPostRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#RenderResult"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ },
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/render-template",
+ "code": 200
+ },
+ "smithy.api#documentation": "Render template\n\nRender a template, either fetched from the settings of an index (embedder document template,\nchat document template, indexing or search fragment) or provided inline, by injecting the\ngiven input (a document from an index, an inline document, or a search query).\n\nReturns the template and the rendered result, allowing to preview how Meilisearch renders\ntemplates without indexing any document.\n\nThis route is only available when the `renderRoute` [experimental feature](https://www.meilisearch.com/docs/resources/help/experimental_features_overview) is enabled."
+ }
+ },
+ "com.meilisearch.api#CreateSnapshot": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/snapshots",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create snapshot\n\nTrigger a snapshot creation process. When complete, a snapshot file is written to the snapshot directory. The directory is created if it does not exist."
+ }
+ },
+ "com.meilisearch.api#GetStatsRequest": {
+ "type": "structure",
+ "members": {
+ "showInternalDatabaseSizes": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "showInternalDatabaseSizes",
+ "smithy.api#documentation": "If `true`, adds `internalDatabaseSizes` to the response."
+ }
+ },
+ "sizeFormat": {
+ "target": "com.meilisearch.api#SizeFormat",
+ "traits": {
+ "smithy.api#httpQuery": "sizeFormat",
+ "smithy.api#documentation": "Specify how to format the sizes:\n\n- `\"raw\"` (default): format sizes as a number of bytes\n- `\"human\"`: format sizes as a human-readable string with an appropriate unit."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#Stats": {
+ "type": "structure",
+ "members": {
+ "databaseSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Total disk space used by the database in bytes",
+ "smithy.api#required": {}
+ }
+ },
+ "usedDatabaseSize": {
+ "target": "com.meilisearch.api#Size",
+ "traits": {
+ "smithy.api#documentation": "Actual size of the data in the database in bytes",
+ "smithy.api#required": {}
+ }
+ },
+ "lastUpdate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Date of the last update in RFC 3339 format. Null if no update has been\nprocessed",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexes": {
+ "target": "com.meilisearch.api#StatsIndexesMap",
+ "traits": {
+ "smithy.api#documentation": "Statistics for each index",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Global statistics for the Meilisearch instance"
+ }
+ },
+ "com.meilisearch.api#StatsIndexesMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#IndexStats"
+ },
+ "traits": {
+ "smithy.api#documentation": "Statistics for each index"
+ }
+ },
+ "com.meilisearch.api#GetStats": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetStatsRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#Stats"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/stats",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get stats of all indexes\n\nReturn statistics for the Meilisearch instance and for each index. Includes database size, last update time, document counts, and indexing status per index."
+ }
+ },
+ "com.meilisearch.api#SwapIndexesPayload": {
+ "type": "structure",
+ "members": {
+ "indexes": {
+ "target": "com.meilisearch.api#SwapIndexesPayloadIndexesList",
+ "traits": {
+ "smithy.api#documentation": "Array of the two index names to be swapped",
+ "smithy.api#required": {}
+ }
+ },
+ "rename": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "If true, rename the first index to the second instead of swapping"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Request body for swapping two indexes"
+ }
+ },
+ "com.meilisearch.api#SwapIndexesPayloadIndexesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of the two index names to be swapped"
+ }
+ },
+ "com.meilisearch.api#SwapIndexesRequestBodyList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#SwapIndexesPayload"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#SwapIndexesRequest": {
+ "type": "structure",
+ "members": {
+ "body": {
+ "target": "com.meilisearch.api#SwapIndexesRequestBodyList",
+ "traits": {
+ "smithy.api#httpPayload": {},
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SwapIndexes": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#SwapIndexesRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/swap-indexes",
+ "code": 200
+ },
+ "smithy.api#documentation": "Swap indexes\n\nSwap the documents, primary key, settings, and task history of two or more indexes.\n\nIndexes are swapped in pairs; a single request can include multiple pairs.\nThe operation is atomic: either all swaps succeed or none do. In the task history, every mention of one index uid is replaced by the other and vice versa.\nEnqueued tasks are left unmodified."
+ }
+ },
+ "com.meilisearch.api#GetTasksRequestBatchUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequestUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequestCanceledByList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequestTypesList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequestStatusesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Status"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequestIndexUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetTasksRequest": {
+ "type": "structure",
+ "members": {
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "limit",
+ "smithy.api#documentation": "Maximum number of batches to return."
+ }
+ },
+ "from": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpQuery": "from",
+ "smithy.api#documentation": "`uid` of the first batch returned."
+ }
+ },
+ "reverse": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#httpQuery": "reverse",
+ "smithy.api#documentation": "If `true`, returns results in the reverse order, from oldest to most recent."
+ }
+ },
+ "batchUids": {
+ "target": "com.meilisearch.api#GetTasksRequestBatchUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "batchUids",
+ "smithy.api#documentation": "Permits to filter tasks by their batch uid. By default, when the\n`batchUids` query parameter is not set, all task uids are returned.\nIt's possible to specify several batch uids by separating them with\nthe `,` character."
+ }
+ },
+ "uids": {
+ "target": "com.meilisearch.api#GetTasksRequestUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "uids",
+ "smithy.api#documentation": "Permits to filter tasks by their uid. By default, when the uids query\nparameter is not set, all task uids are returned. It's possible to\nspecify several uids by separating them with the `,` character."
+ }
+ },
+ "canceledBy": {
+ "target": "com.meilisearch.api#GetTasksRequestCanceledByList",
+ "traits": {
+ "smithy.api#httpQuery": "canceledBy",
+ "smithy.api#documentation": "Permits to filter tasks using the uid of the task that canceled them.\nIt's possible to specify several task uids by separating them with\nthe `,` character."
+ }
+ },
+ "types": {
+ "target": "com.meilisearch.api#GetTasksRequestTypesList",
+ "traits": {
+ "smithy.api#httpQuery": "types",
+ "smithy.api#documentation": "Permits to filter tasks by their related type. By default, when `types`\nquery parameter is not set, all task types are returned. It's possible\nto specify several types by separating them with the `,` character."
+ }
+ },
+ "statuses": {
+ "target": "com.meilisearch.api#GetTasksRequestStatusesList",
+ "traits": {
+ "smithy.api#httpQuery": "statuses",
+ "smithy.api#documentation": "Permits to filter tasks by their status. By default, when `statuses`\nquery parameter is not set, all task statuses are returned. It's\npossible to specify several statuses by separating them with the `,`\ncharacter."
+ }
+ },
+ "indexUids": {
+ "target": "com.meilisearch.api#GetTasksRequestIndexUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "indexUids",
+ "smithy.api#documentation": "Permits to filter tasks by their related index. By default, when\n`indexUids` query parameter is not set, the tasks of all the indexes\nare returned. It is possible to specify several indexes by separating\nthem with the `,` character."
+ }
+ },
+ "afterEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished before the given date. Supports RFC 3339 date format."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#AllTasks": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#AllTasksResultsList",
+ "traits": {
+ "smithy.api#documentation": "Array of task objects matching the query",
+ "smithy.api#required": {}
+ }
+ },
+ "total": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Total number of tasks matching the query",
+ "smithy.api#required": {}
+ }
+ },
+ "limit": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Maximum number of tasks returned",
+ "smithy.api#required": {}
+ }
+ },
+ "from": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The first task uid returned",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "next": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Value to pass as `from` parameter to get the next page. When `null`, there are no more tasks to retrieve.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Response containing a paginated list of tasks"
+ }
+ },
+ "com.meilisearch.api#TaskView": {
+ "type": "structure",
+ "members": {
+ "uid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The unique sequential identifier assigned to this task. Task UIDs are\nassigned in order of creation and can be used to retrieve specific\ntask information or track task dependencies.",
+ "smithy.api#required": {}
+ }
+ },
+ "batchUid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The unique identifier of the batch that processed this task. Multiple\ntasks may share the same batch UID if they were processed together\nfor efficiency. This is `null` for tasks that haven't been processed.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The unique identifier of the index this task operates on. This is\n`null` for global tasks like `dumpCreation` or `taskDeletion` that\ndon't target a specific index.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "status": {
+ "target": "com.meilisearch.api#Status",
+ "traits": {
+ "smithy.api#documentation": "The current processing status of the task. Possible values are:\n`enqueued` (waiting), `processing` (executing), `succeeded`,\n`failed`, or `canceled`.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#Kind",
+ "traits": {
+ "smithy.api#documentation": "The type of operation this task performs. Examples include\n`documentAdditionOrUpdate`, `documentDeletion`, `settingsUpdate`,\n`indexCreation`, `indexDeletion`, `dumpCreation`, etc.",
+ "smithy.api#required": {}
+ }
+ },
+ "canceledBy": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "If this task was canceled, this field contains the UID of the\n`taskCancelation` task that canceled it. This is `null` for tasks\nthat were not canceled.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "details": {
+ "target": "smithy.api#Document",
+ "traits": {
+ "smithy.api#documentation": "Contains type-specific information about the task, such as the number\nof documents processed, settings that were applied, or filters that\nwere used. The structure varies depending on the task type.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "error": {
+ "target": "com.meilisearch.api#ResponseError",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "duration": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The total time spent processing this task, formatted as an ISO-8601\nduration (e.g., `PT0.5S` for 0.5 seconds). This is `null` for tasks\nthat haven't finished processing yet.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "enqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The timestamp when this task was added to the queue, formatted as an\nRFC 3339 date-time string. All tasks have an enqueued timestamp as\nit's set when the task is created.",
+ "smithy.api#required": {}
+ }
+ },
+ "startedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The timestamp when Meilisearch began processing this task, formatted\nas an RFC 3339 date-time string. This is `null` for tasks that are\nstill in the queue waiting to be processed."
+ }
+ },
+ "finishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The timestamp when this task finished processing (whether successfully\nor with an error), formatted as an RFC 3339 date-time string. This is\n`null` for tasks that haven't finished yet."
+ }
+ },
+ "network": {
+ "target": "com.meilisearch.api#DbTaskNetwork",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Custom metadata string that was attached to this task when it was\ncreated. This can be used to associate tasks with external systems,\ntrack task origins, or add any application-specific information.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents the current state and details of an asynchronous task.\n\nTasks are created when you perform operations like adding documents,\nupdating settings, or creating indexes. Use this view to monitor task\nprogress and check for errors."
+ }
+ },
+ "com.meilisearch.api#Kind": {
+ "type": "enum",
+ "members": {
+ "DOCUMENTADDITIONORUPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documentAdditionOrUpdate"
+ }
+ },
+ "DOCUMENTEDITION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documentEdition"
+ }
+ },
+ "DOCUMENTDELETION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "documentDeletion"
+ }
+ },
+ "SETTINGSUPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "settingsUpdate"
+ }
+ },
+ "INDEXCREATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexCreation"
+ }
+ },
+ "INDEXDELETION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexDeletion"
+ }
+ },
+ "INDEXUPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexUpdate"
+ }
+ },
+ "INDEXSWAP": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexSwap"
+ }
+ },
+ "TASKCANCELATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "taskCancelation"
+ }
+ },
+ "TASKDELETION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "taskDeletion"
+ }
+ },
+ "DUMPCREATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dumpCreation"
+ }
+ },
+ "SNAPSHOTCREATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "snapshotCreation"
+ }
+ },
+ "EXPORT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "export"
+ }
+ },
+ "UPGRADEDATABASE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "upgradeDatabase"
+ }
+ },
+ "INDEXCOMPACTION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "indexCompaction"
+ }
+ },
+ "NETWORKTOPOLOGYCHANGE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "networkTopologyChange"
+ }
+ },
+ "DSRUPDATE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dsrUpdate"
+ }
+ },
+ "DSRCLEAR": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "dsrClear"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "The type of the task."
+ }
+ },
+ "com.meilisearch.api#DbTaskNetwork": {
+ "type": "union",
+ "members": {
+ "Case0": {
+ "target": "com.meilisearch.api#DbTaskNetworkCase0"
+ },
+ "Case1": {
+ "target": "com.meilisearch.api#DbTaskNetworkCase1"
+ },
+ "Case2": {
+ "target": "com.meilisearch.api#DbTaskNetworkCase2"
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DbTaskNetworkCase0": {
+ "type": "structure",
+ "members": {
+ "origin": {
+ "target": "com.meilisearch.api#Origin",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Tasks that were duplicated from `origin`"
+ }
+ },
+ "com.meilisearch.api#RemoteTask": {
+ "type": "structure",
+ "members": {
+ "taskUid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "The unique task identifier assigned by the remote Meilisearch instance.\nPresent when the task was successfully replicated to the remote.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "error": {
+ "target": "com.meilisearch.api#ResponseError",
+ "traits": {
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Represents a task that was replicated to a remote Meilisearch instance.\nContains either the remote task UID on success, or an error if\nreplication failed."
+ }
+ },
+ "com.meilisearch.api#DbTaskNetworkCase1RemoteTasksMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "com.meilisearch.api#RemoteTask"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DbTaskNetworkCase1": {
+ "type": "structure",
+ "members": {
+ "remote_tasks": {
+ "target": "com.meilisearch.api#DbTaskNetworkCase1RemoteTasksMap",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "network_version": {
+ "target": "smithy.api#String"
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Tasks that were duplicated as `remote_tasks`"
+ }
+ },
+ "com.meilisearch.api#ImportData": {
+ "type": "structure",
+ "members": {
+ "remoteName": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Remote that this task is imported from",
+ "smithy.api#required": {}
+ }
+ },
+ "indexName": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Index relevant to this task",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "documentCount": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Number of documents in this task",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Import data stored in a task"
+ }
+ },
+ "com.meilisearch.api#DbTaskNetworkCase2": {
+ "type": "structure",
+ "members": {
+ "import_from": {
+ "target": "com.meilisearch.api#ImportData",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ },
+ "network_change": {
+ "target": "com.meilisearch.api#Origin",
+ "traits": {
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Document import tasks sent in the context of `network_change`"
+ }
+ },
+ "com.meilisearch.api#AllTasksResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#TaskView"
+ },
+ "traits": {
+ "smithy.api#documentation": "Array of task objects matching the query"
+ }
+ },
+ "com.meilisearch.api#GetTasks": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetTasksRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#AllTasks"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/tasks",
+ "code": 200
+ },
+ "smithy.api#documentation": "List tasks\n\nThe `/tasks` route returns information about [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) (indexing, document updates, settings changes, and so on).\n\nTasks are returned in descending order of uid by default, so the most recently created or updated tasks appear first. Results are paginated and can be filtered using query parameters such as `indexUids`, `statuses`, `types`, and date ranges."
+ }
+ },
+ "com.meilisearch.api#DeleteTasksRequestUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequestBatchUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequestCanceledByList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequestTypesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Kind"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequestStatusesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Status"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequestIndexUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#DeleteTasksRequest": {
+ "type": "structure",
+ "members": {
+ "uids": {
+ "target": "com.meilisearch.api#DeleteTasksRequestUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "uids",
+ "smithy.api#documentation": "Permits to select tasks by their uid. When the `uids` query\nparameter is set to `*`, all task uids included. It's possible to\nspecify several uids by separating them with the `,` character."
+ }
+ },
+ "batchUids": {
+ "target": "com.meilisearch.api#DeleteTasksRequestBatchUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "batchUids",
+ "smithy.api#documentation": "Lets you filter tasks by their `batchUid`."
+ }
+ },
+ "canceledBy": {
+ "target": "com.meilisearch.api#DeleteTasksRequestCanceledByList",
+ "traits": {
+ "smithy.api#httpQuery": "canceledBy",
+ "smithy.api#documentation": "Permits to filter tasks using the uid of the task that canceled them.\nIt's possible to specify several task uids by separating them with\nthe `,` character."
+ }
+ },
+ "types": {
+ "target": "com.meilisearch.api#DeleteTasksRequestTypesList",
+ "traits": {
+ "smithy.api#httpQuery": "types",
+ "smithy.api#documentation": "Permits to filter tasks by their related type. By default, when `types`\nquery parameter is not set, all task types are returned. It's possible\nto specify several types by separating them with the `,` character."
+ }
+ },
+ "statuses": {
+ "target": "com.meilisearch.api#DeleteTasksRequestStatusesList",
+ "traits": {
+ "smithy.api#httpQuery": "statuses",
+ "smithy.api#documentation": "Permits to filter tasks by their status. By default, when `statuses`\nquery parameter is not set, all task statuses are returned. It's\npossible to specify several statuses by separating them with the `,`\ncharacter."
+ }
+ },
+ "indexUids": {
+ "target": "com.meilisearch.api#DeleteTasksRequestIndexUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "indexUids",
+ "smithy.api#documentation": "Permits to filter tasks by their related index. By default, when\n`indexUids` query parameter is not set, the tasks of all the indexes\nare returned. It is possible to specify several indexes by separating\nthem with the `,` character."
+ }
+ },
+ "afterEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished before the given date. Supports RFC 3339 date format."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#SummarizedTaskView": {
+ "type": "structure",
+ "members": {
+ "taskUid": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#documentation": "Unique sequential identifier of the task.",
+ "smithy.api#required": {}
+ }
+ },
+ "indexUid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the targeted index. Null for global tasks.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "status": {
+ "target": "com.meilisearch.api#Status",
+ "traits": {
+ "smithy.api#documentation": "Status of the task. Possible values are `enqueued`, `processing`,\n`succeeded`, `failed`, and `canceled`.",
+ "smithy.api#required": {}
+ }
+ },
+ "type": {
+ "target": "com.meilisearch.api#Kind",
+ "traits": {
+ "smithy.api#documentation": "Type of operation performed by the task.",
+ "smithy.api#required": {}
+ }
+ },
+ "enqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Date and time when the task was enqueued.",
+ "smithy.api#required": {}
+ }
+ },
+ "customMetadata": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Custom metadata attached to this task at creation. Use it to associate\ntasks with external systems or add application-specific information.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "A summarized view of a task, returned when a task is enqueued"
+ }
+ },
+ "com.meilisearch.api#DeleteTasks": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteTasksRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SummarizedTaskView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ },
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/tasks",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete tasks\n\nPermanently delete [tasks](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) matching the given filters. You must provide at least one filter (e.g. `uids`, `indexUids`, `statuses`) to specify which tasks to delete.\n\n**Note:** Only finished tasks (`succeeded`, `failed`, or `canceled`) can be deleted.\nYou cannot delete `enqueued` or `processing` tasks.\n\n**Note:** Task deletion is atomic — either all matched tasks are deleted or none are.\n\n**Note:** Each filter parameter accepts `*` to match all values (e.g., `statuses=*`)."
+ }
+ },
+ "com.meilisearch.api#CancelTasksRequestUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequestBatchUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequestCanceledByList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#Integer"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequestTypesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Kind"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequestStatusesList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#Status"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequestIndexUidsList": {
+ "type": "list",
+ "member": {
+ "target": "smithy.api#String"
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CancelTasksRequest": {
+ "type": "structure",
+ "members": {
+ "uids": {
+ "target": "com.meilisearch.api#CancelTasksRequestUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "uids",
+ "smithy.api#documentation": "Permits to select tasks by their uid. When the `uids` query\nparameter is set to `*`, all task uids included. It's possible to\nspecify several uids by separating them with the `,` character."
+ }
+ },
+ "batchUids": {
+ "target": "com.meilisearch.api#CancelTasksRequestBatchUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "batchUids",
+ "smithy.api#documentation": "Lets you filter tasks by their `batchUid`."
+ }
+ },
+ "canceledBy": {
+ "target": "com.meilisearch.api#CancelTasksRequestCanceledByList",
+ "traits": {
+ "smithy.api#httpQuery": "canceledBy",
+ "smithy.api#documentation": "Permits to filter tasks using the uid of the task that canceled them.\nIt's possible to specify several task uids by separating them with\nthe `,` character."
+ }
+ },
+ "types": {
+ "target": "com.meilisearch.api#CancelTasksRequestTypesList",
+ "traits": {
+ "smithy.api#httpQuery": "types",
+ "smithy.api#documentation": "Permits to filter tasks by their related type. By default, when `types`\nquery parameter is not set, all task types are returned. It's possible\nto specify several types by separating them with the `,` character."
+ }
+ },
+ "statuses": {
+ "target": "com.meilisearch.api#CancelTasksRequestStatusesList",
+ "traits": {
+ "smithy.api#httpQuery": "statuses",
+ "smithy.api#documentation": "Permits to filter tasks by their status. By default, when `statuses`\nquery parameter is not set, all task statuses are returned. It's\npossible to specify several statuses by separating them with the `,`\ncharacter."
+ }
+ },
+ "indexUids": {
+ "target": "com.meilisearch.api#CancelTasksRequestIndexUidsList",
+ "traits": {
+ "smithy.api#httpQuery": "indexUids",
+ "smithy.api#documentation": "Permits to filter tasks by their related index. By default, when\n`indexUids` query parameter is not set, the tasks of all the indexes\nare returned. It is possible to specify several indexes by separating\nthem with the `,` character."
+ }
+ },
+ "afterEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeEnqueuedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeEnqueuedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their enqueuedAt time. Matches tasks\nenqueued before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeStartedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeStartedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their startedAt time. Matches tasks\nstarted before the given date. Supports RFC 3339 date format."
+ }
+ },
+ "afterFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "afterFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished after the given date. Supports RFC 3339 date format."
+ }
+ },
+ "beforeFinishedAt": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpQuery": "beforeFinishedAt",
+ "smithy.api#documentation": "Permits to filter tasks based on their finishedAt time. Matches tasks\nfinished before the given date. Supports RFC 3339 date format."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#CancelTasks": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#CancelTasksRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#SummarizedTaskView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/tasks/cancel",
+ "code": 200
+ },
+ "smithy.api#documentation": "Cancel tasks\n\nCancel enqueued and/or processing [tasks](https://www.meilisearch.com/docs/learn/async/asynchronous_operations). You must provide at least one filter (e.g. `uids`, `indexUids`, `statuses`) to specify which tasks to cancel.\n\n**Note:** Task cancellation is atomic — either all matched tasks are canceled or none are.\n\n**Note:** Each filter parameter accepts `*` to match all values (e.g., `statuses=*`).\n\n**Tip:** You can cancel `taskCancelation` type tasks as long as they are `enqueued` or `processing`,\nbecause cancellation tasks are processed in reverse order of enqueueing."
+ }
+ },
+ "com.meilisearch.api#TaskCompactionSummary": {
+ "type": "structure",
+ "members": {
+ "preSize": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Size of the task queue database before compaction."
+ }
+ },
+ "postSize": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Size of the task queue database after compaction."
+ }
+ },
+ "status": {
+ "target": "com.meilisearch.api#Status",
+ "traits": {
+ "smithy.api#documentation": "Outcome of the compaction operation.",
+ "smithy.api#required": {}
+ }
+ },
+ "actionRequired": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Follow-up action required after a successful compaction.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "errorMessage": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Error message if compaction failed.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#CompactTaskQueue": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#TaskCompactionSummary"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/tasks/compact",
+ "code": 200
+ },
+ "smithy.api#documentation": "Compact task queue\n\nTrigger a compaction process on the task queue database and return its size before and\nafter compaction. A successful compaction requires restarting the instance before it can\nsafely resume normal writes."
+ }
+ },
+ "com.meilisearch.api#GetTasksStream": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/tasks/stream",
+ "code": 200
+ },
+ "smithy.api#documentation": "Stream tasks changes\n\nThe `/tasks/stream` route returns information about [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) (indexing, document updates, settings changes, and so on).\n\nTasks are sent throught an SSE stream any time their status changes, i.e., enqueued, processing, succeeded, failed."
+ }
+ },
+ "com.meilisearch.api#GetTaskRequest": {
+ "type": "structure",
+ "members": {
+ "task_id": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The task identifier."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetTask": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetTaskRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#TaskView"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/tasks/{task_id}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get task\n\nRetrieve a single [task](https://www.meilisearch.com/docs/learn/async/asynchronous_operations) by its uid."
+ }
+ },
+ "com.meilisearch.api#GetTaskDocumentsFileRequest": {
+ "type": "structure",
+ "members": {
+ "task_id": {
+ "target": "smithy.api#Integer",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "The task identifier."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetTaskDocumentsFile": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetTaskDocumentsFileRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/tasks/{task_id}/documents",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get task's document payload\n\nRetrieve the document payload that was sent with this [task](https://www.meilisearch.com/docs/learn/async/asynchronous_operations).\nOnly available for document-related tasks that are enqueued or processing."
+ }
+ },
+ "com.meilisearch.api#VersionResponse": {
+ "type": "structure",
+ "members": {
+ "commitSha": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The commit used to compile this build of Meilisearch.",
+ "smithy.api#required": {}
+ }
+ },
+ "commitDate": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The date of this build.",
+ "smithy.api#required": {}
+ }
+ },
+ "pkgVersion": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "The version of Meilisearch.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {}
+ },
+ "com.meilisearch.api#GetVersion": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#VersionResponse"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/version",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get version\n\nReturn the current Meilisearch version, including the commit SHA and build date."
+ }
+ },
+ "com.meilisearch.api#WebhookResults": {
+ "type": "structure",
+ "members": {
+ "results": {
+ "target": "com.meilisearch.api#WebhookResultsResultsList",
+ "traits": {
+ "smithy.api#documentation": "All webhooks configured on the instance. Each entry includes UUID, URL, headers (authorization redacted), and editability.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Response containing a list of all registered webhooks."
+ }
+ },
+ "com.meilisearch.api#WebhookWithMetadataRedactedAuthorization": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#WebhookWithMetadataRedactedAuthorizationHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the webhook.",
+ "smithy.api#required": {}
+ }
+ },
+ "isEditable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the webhook can be edited.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "Webhook object with metadata and redacted authorization headers."
+ }
+ },
+ "com.meilisearch.api#WebhookWithMetadataRedactedAuthorizationHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#WebhookResultsResultsList": {
+ "type": "list",
+ "member": {
+ "target": "com.meilisearch.api#WebhookWithMetadataRedactedAuthorization"
+ },
+ "traits": {
+ "smithy.api#documentation": "All webhooks configured on the instance. Each entry includes UUID, URL, headers (authorization redacted), and editability."
+ }
+ },
+ "com.meilisearch.api#GetWebhooks": {
+ "type": "operation",
+ "input": {
+ "target": "smithy.api#Unit"
+ },
+ "output": {
+ "target": "com.meilisearch.api#WebhookResults"
+ },
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/webhooks",
+ "code": 200
+ },
+ "smithy.api#documentation": "List webhooks\n\nReturn all webhooks registered on the instance. Each webhook is returned with its URL, optional headers, and UUID (the key value is never returned)."
+ }
+ },
+ "com.meilisearch.api#PostWebhookRequestHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#PostWebhookRequest": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#PostWebhookRequestHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PostWebhookResponseHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#PostWebhookResponse": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#PostWebhookResponseHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the webhook.",
+ "smithy.api#required": {}
+ }
+ },
+ "isEditable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the webhook can be edited.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#PostWebhook": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PostWebhookRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PostWebhookResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "POST",
+ "uri": "/webhooks",
+ "code": 200
+ },
+ "smithy.api#documentation": "Create webhook\n\nRegister a new webhook to receive task completion notifications. You can optionally set custom headers (e.g. for authentication) and configure the callback URL."
+ }
+ },
+ "com.meilisearch.api#GetWebhookRequest": {
+ "type": "structure",
+ "members": {
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Universally unique identifier of the webhook."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#GetWebhookResponseHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#GetWebhookResponse": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#GetWebhookResponseHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the webhook.",
+ "smithy.api#required": {}
+ }
+ },
+ "isEditable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the webhook can be edited.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#GetWebhook": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#GetWebhookRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#GetWebhookResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "GET",
+ "uri": "/webhooks/{uuid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Get webhook\n\nRetrieve a single webhook by its UUID."
+ }
+ },
+ "com.meilisearch.api#PatchWebhookRequestHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#PatchWebhookRequest": {
+ "type": "structure",
+ "members": {
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Universally unique identifier of the webhook."
+ }
+ },
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#PatchWebhookRequestHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#PatchWebhookResponseHeadersMap": {
+ "type": "map",
+ "key": {
+ "target": "smithy.api#String"
+ },
+ "value": {
+ "target": "smithy.api#String"
+ },
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests."
+ }
+ },
+ "com.meilisearch.api#PatchWebhookResponse": {
+ "type": "structure",
+ "members": {
+ "url": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "URL endpoint to call when tasks complete.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "headers": {
+ "target": "com.meilisearch.api#PatchWebhookResponseHeadersMap",
+ "traits": {
+ "smithy.api#documentation": "HTTP headers to include in webhook requests.",
+ "com.distilled.openapi#nullable": {}
+ }
+ },
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#documentation": "Unique identifier of the webhook.",
+ "smithy.api#required": {}
+ }
+ },
+ "isEditable": {
+ "target": "smithy.api#Boolean",
+ "traits": {
+ "smithy.api#documentation": "Whether the webhook can be edited.",
+ "smithy.api#required": {}
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#output": {}
+ }
+ },
+ "com.meilisearch.api#PatchWebhook": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#PatchWebhookRequest"
+ },
+ "output": {
+ "target": "com.meilisearch.api#PatchWebhookResponse"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#BadRequest"
+ },
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "PATCH",
+ "uri": "/webhooks/{uuid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Update webhook\n\nUpdate the URL or headers of an existing webhook identified by its UUID."
+ }
+ },
+ "com.meilisearch.api#DeleteWebhookRequest": {
+ "type": "structure",
+ "members": {
+ "uuid": {
+ "target": "smithy.api#String",
+ "traits": {
+ "smithy.api#httpLabel": {},
+ "smithy.api#required": {},
+ "smithy.api#documentation": "Universally unique identifier of the webhook."
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#input": {}
+ }
+ },
+ "com.meilisearch.api#DeleteWebhook": {
+ "type": "operation",
+ "input": {
+ "target": "com.meilisearch.api#DeleteWebhookRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.meilisearch.api#NotFound"
+ }
+ ],
+ "traits": {
+ "smithy.api#http": {
+ "method": "DELETE",
+ "uri": "/webhooks/{uuid}",
+ "code": 200
+ },
+ "smithy.api#documentation": "Delete webhook\n\nPermanently remove a webhook by its UUID. The webhook will no longer receive task notifications."
+ }
+ },
+ "com.meilisearch.api#NotFound": {
+ "type": "structure",
+ "members": {},
+ "traits": {
+ "smithy.api#error": "client",
+ "smithy.api#httpError": 404,
+ "com.distilled.openapi#errorMatchers": [
+ {
+ "status": 404
+ }
+ ]
+ }
+ },
+ "com.meilisearch.api#BadRequest": {
+ "type": "structure",
+ "members": {},
+ "traits": {
+ "smithy.api#error": "client",
+ "smithy.api#httpError": 400,
+ "com.distilled.openapi#errorMatchers": [
+ {
+ "status": 400
+ }
+ ]
+ }
+ },
+ "com.meilisearch.api#Meilisearch": {
+ "type": "service",
+ "version": "1.53.0",
+ "operations": [
+ {
+ "target": "com.meilisearch.api#GetBatches"
+ },
+ {
+ "target": "com.meilisearch.api#GetBatchesStream"
+ },
+ {
+ "target": "com.meilisearch.api#GetBatch"
+ },
+ {
+ "target": "com.meilisearch.api#ListWorkspaces"
+ },
+ {
+ "target": "com.meilisearch.api#GetChat"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteChat"
+ },
+ {
+ "target": "com.meilisearch.api#Chat"
+ },
+ {
+ "target": "com.meilisearch.api#GetSettings"
+ },
+ {
+ "target": "com.meilisearch.api#PatchSettings"
+ },
+ {
+ "target": "com.meilisearch.api#ResetSettings"
+ },
+ {
+ "target": "com.meilisearch.api#CreateDump"
+ },
+ {
+ "target": "com.meilisearch.api#ListRules"
+ },
+ {
+ "target": "com.meilisearch.api#ClearRules"
+ },
+ {
+ "target": "com.meilisearch.api#GetRule"
+ },
+ {
+ "target": "com.meilisearch.api#UpdateOrCreateRule"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteRule"
+ },
+ {
+ "target": "com.meilisearch.api#GetFeatures"
+ },
+ {
+ "target": "com.meilisearch.api#PatchFeatures"
+ },
+ {
+ "target": "com.meilisearch.api#Export"
+ },
+ {
+ "target": "com.meilisearch.api#GetHealth"
+ },
+ {
+ "target": "com.meilisearch.api#ListIndexes"
+ },
+ {
+ "target": "com.meilisearch.api#CreateIndex"
+ },
+ {
+ "target": "com.meilisearch.api#GetIndex"
+ },
+ {
+ "target": "com.meilisearch.api#UpdateIndex"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteIndex"
+ },
+ {
+ "target": "com.meilisearch.api#Compact"
+ },
+ {
+ "target": "com.meilisearch.api#GetDocuments"
+ },
+ {
+ "target": "com.meilisearch.api#ReplaceDocuments"
+ },
+ {
+ "target": "com.meilisearch.api#UpdateDocuments"
+ },
+ {
+ "target": "com.meilisearch.api#ClearAllDocuments"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteDocumentsByFilter"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteDocumentsBatch"
+ },
+ {
+ "target": "com.meilisearch.api#EditDocumentsByFunction"
+ },
+ {
+ "target": "com.meilisearch.api#DocumentsByQueryPost"
+ },
+ {
+ "target": "com.meilisearch.api#GetDocument"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteDocument"
+ },
+ {
+ "target": "com.meilisearch.api#Search"
+ },
+ {
+ "target": "com.meilisearch.api#PostIndexFields"
+ },
+ {
+ "target": "com.meilisearch.api#SearchWithUrlQuery"
+ },
+ {
+ "target": "com.meilisearch.api#SearchWithPost"
+ },
+ {
+ "target": "com.meilisearch.api#GetAll"
+ },
+ {
+ "target": "com.meilisearch.api#UpdateAll"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteAll"
+ },
+ {
+ "target": "com.meilisearch.api#Getchat"
+ },
+ {
+ "target": "com.meilisearch.api#Patchchat"
+ },
+ {
+ "target": "com.meilisearch.api#Deletechat"
+ },
+ {
+ "target": "com.meilisearch.api#Getdictionary"
+ },
+ {
+ "target": "com.meilisearch.api#Putdictionary"
+ },
+ {
+ "target": "com.meilisearch.api#Deletedictionary"
+ },
+ {
+ "target": "com.meilisearch.api#GetdisplayedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#PutdisplayedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#DeletedisplayedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#GetdistinctAttribute"
+ },
+ {
+ "target": "com.meilisearch.api#PutdistinctAttribute"
+ },
+ {
+ "target": "com.meilisearch.api#DeletedistinctAttribute"
+ },
+ {
+ "target": "com.meilisearch.api#Getembedders"
+ },
+ {
+ "target": "com.meilisearch.api#Patchembedders"
+ },
+ {
+ "target": "com.meilisearch.api#Deleteembedders"
+ },
+ {
+ "target": "com.meilisearch.api#GetfacetSearch"
+ },
+ {
+ "target": "com.meilisearch.api#PutfacetSearch"
+ },
+ {
+ "target": "com.meilisearch.api#DeletefacetSearch"
+ },
+ {
+ "target": "com.meilisearch.api#Getfaceting"
+ },
+ {
+ "target": "com.meilisearch.api#Patchfaceting"
+ },
+ {
+ "target": "com.meilisearch.api#Deletefaceting"
+ },
+ {
+ "target": "com.meilisearch.api#GetfilterableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#PutfilterableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#DeletefilterableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#GetforeignKeys"
+ },
+ {
+ "target": "com.meilisearch.api#PutforeignKeys"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteforeignKeys"
+ },
+ {
+ "target": "com.meilisearch.api#GetlocalizedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#PutlocalizedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#DeletelocalizedAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#GetnonSeparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#PutnonSeparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#DeletenonSeparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#Getpagination"
+ },
+ {
+ "target": "com.meilisearch.api#Patchpagination"
+ },
+ {
+ "target": "com.meilisearch.api#Deletepagination"
+ },
+ {
+ "target": "com.meilisearch.api#GetprefixSearch"
+ },
+ {
+ "target": "com.meilisearch.api#PutprefixSearch"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteprefixSearch"
+ },
+ {
+ "target": "com.meilisearch.api#GetproximityPrecision"
+ },
+ {
+ "target": "com.meilisearch.api#PutproximityPrecision"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteproximityPrecision"
+ },
+ {
+ "target": "com.meilisearch.api#GetrankingRules"
+ },
+ {
+ "target": "com.meilisearch.api#PutrankingRules"
+ },
+ {
+ "target": "com.meilisearch.api#DeleterankingRules"
+ },
+ {
+ "target": "com.meilisearch.api#GetsearchCutoffMs"
+ },
+ {
+ "target": "com.meilisearch.api#PutsearchCutoffMs"
+ },
+ {
+ "target": "com.meilisearch.api#DeletesearchCutoffMs"
+ },
+ {
+ "target": "com.meilisearch.api#GetsearchableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#PutsearchableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#DeletesearchableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#GetseparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#PutseparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteseparatorTokens"
+ },
+ {
+ "target": "com.meilisearch.api#GetsortableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#PutsortableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#DeletesortableAttributes"
+ },
+ {
+ "target": "com.meilisearch.api#GetstopWords"
+ },
+ {
+ "target": "com.meilisearch.api#PutstopWords"
+ },
+ {
+ "target": "com.meilisearch.api#DeletestopWords"
+ },
+ {
+ "target": "com.meilisearch.api#Getsynonyms"
+ },
+ {
+ "target": "com.meilisearch.api#Putsynonyms"
+ },
+ {
+ "target": "com.meilisearch.api#Deletesynonyms"
+ },
+ {
+ "target": "com.meilisearch.api#GettypoTolerance"
+ },
+ {
+ "target": "com.meilisearch.api#PatchtypoTolerance"
+ },
+ {
+ "target": "com.meilisearch.api#DeletetypoTolerance"
+ },
+ {
+ "target": "com.meilisearch.api#SimilarGet"
+ },
+ {
+ "target": "com.meilisearch.api#SimilarPost"
+ },
+ {
+ "target": "com.meilisearch.api#GetIndexStats"
+ },
+ {
+ "target": "com.meilisearch.api#ListApiKeys"
+ },
+ {
+ "target": "com.meilisearch.api#CreateApiKey"
+ },
+ {
+ "target": "com.meilisearch.api#GetApiKey"
+ },
+ {
+ "target": "com.meilisearch.api#PatchApiKey"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteApiKey"
+ },
+ {
+ "target": "com.meilisearch.api#UpdateStderrTarget"
+ },
+ {
+ "target": "com.meilisearch.api#GetLogs"
+ },
+ {
+ "target": "com.meilisearch.api#CancelLogs"
+ },
+ {
+ "target": "com.meilisearch.api#GetMetrics"
+ },
+ {
+ "target": "com.meilisearch.api#MultiSearchWithPost"
+ },
+ {
+ "target": "com.meilisearch.api#GetNetwork"
+ },
+ {
+ "target": "com.meilisearch.api#PatchNetwork"
+ },
+ {
+ "target": "com.meilisearch.api#PostNetworkChange"
+ },
+ {
+ "target": "com.meilisearch.api#RenderPost"
+ },
+ {
+ "target": "com.meilisearch.api#CreateSnapshot"
+ },
+ {
+ "target": "com.meilisearch.api#GetStats"
+ },
+ {
+ "target": "com.meilisearch.api#SwapIndexes"
+ },
+ {
+ "target": "com.meilisearch.api#GetTasks"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteTasks"
+ },
+ {
+ "target": "com.meilisearch.api#CancelTasks"
+ },
+ {
+ "target": "com.meilisearch.api#CompactTaskQueue"
+ },
+ {
+ "target": "com.meilisearch.api#GetTasksStream"
+ },
+ {
+ "target": "com.meilisearch.api#GetTask"
+ },
+ {
+ "target": "com.meilisearch.api#GetTaskDocumentsFile"
+ },
+ {
+ "target": "com.meilisearch.api#GetVersion"
+ },
+ {
+ "target": "com.meilisearch.api#GetWebhooks"
+ },
+ {
+ "target": "com.meilisearch.api#PostWebhook"
+ },
+ {
+ "target": "com.meilisearch.api#GetWebhook"
+ },
+ {
+ "target": "com.meilisearch.api#PatchWebhook"
+ },
+ {
+ "target": "com.meilisearch.api#DeleteWebhook"
+ }
+ ],
+ "traits": {
+ "smithy.api#title": "meilisearch",
+ "smithy.api#documentation": "Meilisearch HTTP server"
+ }
+ }
+ }
+}
diff --git a/packages/meilisearch/package.json b/packages/meilisearch/package.json
new file mode 100644
index 000000000..0c14f8868
--- /dev/null
+++ b/packages/meilisearch/package.json
@@ -0,0 +1,85 @@
+{
+ "name": "@distilled.cloud/meilisearch",
+ "version": "1.0.0-rc.8",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/alchemy-run/distilled",
+ "directory": "packages/meilisearch"
+ },
+ "license": "Apache-2.0",
+ "type": "module",
+ "sideEffects": false,
+ "files": [
+ "lib",
+ "src"
+ ],
+ "exports": {
+ ".": {
+ "types": "./lib/index.d.ts",
+ "bun": "./src/index.ts",
+ "worker": "./src/index.ts",
+ "default": "./lib/index.js"
+ },
+ "./Credentials": {
+ "types": "./lib/credentials.d.ts",
+ "bun": "./src/credentials.ts",
+ "worker": "./src/credentials.ts",
+ "default": "./lib/credentials.js"
+ },
+ "./Errors": {
+ "types": "./lib/errors.d.ts",
+ "bun": "./src/errors.ts",
+ "worker": "./src/errors.ts",
+ "default": "./lib/errors.js"
+ },
+ "./Traits": {
+ "types": "./lib/traits.d.ts",
+ "bun": "./src/traits.ts",
+ "worker": "./src/traits.ts",
+ "default": "./lib/traits.js"
+ },
+ "./Pagination": {
+ "types": "./lib/pagination.d.ts",
+ "bun": "./src/pagination.ts",
+ "worker": "./src/pagination.ts",
+ "default": "./lib/pagination.js"
+ },
+ "./Protocol": {
+ "types": "./lib/protocol.d.ts",
+ "bun": "./src/protocol.ts",
+ "worker": "./src/protocol.ts",
+ "default": "./lib/protocol.js"
+ },
+ "./Retry": {
+ "types": "./lib/retry.d.ts",
+ "bun": "./src/retry.ts",
+ "worker": "./src/retry.ts",
+ "default": "./lib/retry.js"
+ },
+ "./*": {
+ "types": "./lib/services/*.d.ts",
+ "bun": "./src/services/*.ts",
+ "worker": "./src/services/*.ts",
+ "default": "./lib/services/*.js"
+ }
+ },
+ "scripts": {
+ "build": "tsc -b",
+ "convert": "bun scripts/convert.ts",
+ "generate": "bun scripts/convert.ts && bun scripts/generate.ts",
+ "typecheck": "tsc -p tsconfig.json",
+ "specs:fetch": "git submodule update --force --init --depth=1 specs/spec-mirror-meilisearch",
+ "specs:update": "git submodule update --remote --force --depth=1 specs/spec-mirror-meilisearch"
+ },
+ "dependencies": {
+ "@distilled.cloud/core": "workspace:*"
+ },
+ "devDependencies": {
+ "@types/bun": "catalog:tooling",
+ "@types/node": "catalog:tooling",
+ "@effect/platform-bun": "catalog:effect"
+ },
+ "peerDependencies": {
+ "effect": "catalog:effect"
+ }
+}
diff --git a/packages/meilisearch/scripts/convert.ts b/packages/meilisearch/scripts/convert.ts
new file mode 100644
index 000000000..daa5c234b
--- /dev/null
+++ b/packages/meilisearch/scripts/convert.ts
@@ -0,0 +1,32 @@
+#!/usr/bin/env bun
+/**
+ * convert — turn the Meilisearch OpenAPI spec into a Smithy 2.0 JSON model.
+ *
+ * Input: specs/spec-mirror-meilisearch/specs/openapi.json (spec submodule)
+ * patches/*.patch.json (RFC-6902 patches to the OpenAPI document)
+ * Output: .generated-specs/meilisearch.json
+ *
+ * The OpenAPI→Smithy converter lives in
+ * `@distilled.cloud/core/codegen/openapi`; this script is Meilisearch's
+ * pipeline config. `scripts/generate.ts` compiles the model into src/services.
+ */
+import * as path from "node:path";
+import { runOpenApiConvert } from "@distilled.cloud/core/codegen/openapi-cli";
+
+await runOpenApiConvert({
+ root: path.resolve(import.meta.dir, ".."),
+ specs: [
+ {
+ name: "meilisearch",
+ specPath: "specs/spec-mirror-meilisearch/specs/openapi.json",
+ },
+ ],
+ // OpenAPI-document patches (v0 layout: flat patches/*.patch.json). The
+ // smithy-model patch chain in generate.ts is disabled (`patchesDir: false`).
+ patchesDir: "patches",
+ options: {
+ namespace: "com.meilisearch.api",
+ serviceName: "Meilisearch",
+ skipDeprecated: true,
+ },
+});
diff --git a/packages/meilisearch/scripts/generate.ts b/packages/meilisearch/scripts/generate.ts
new file mode 100644
index 000000000..8d05b2183
--- /dev/null
+++ b/packages/meilisearch/scripts/generate.ts
@@ -0,0 +1,93 @@
+#!/usr/bin/env bun
+/**
+ * generate — turn the Smithy JSON model in .generated-specs into the
+ * Meilisearch Effect SDK.
+ *
+ * Input: .generated-specs/meilisearch.json (written by scripts/convert.ts)
+ * Output: src/services/meilisearch.ts + src/services/index.ts
+ *
+ * The smithy→SDK compiler and CLI pipeline live in
+ * `@distilled.cloud/core/codegen`; this script is Meilisearch's provider spec.
+ * Meilisearch keeps the wire's camelCase member names on the TS surface, so
+ * no member renaming or wire dictionaries appear here.
+ */
+import type { SdkSpec } from "@distilled.cloud/core/codegen/generator";
+import { runGeneratorCli } from "@distilled.cloud/core/codegen/cli";
+
+const NULLABLE_TRAIT = "com.distilled.openapi#nullable";
+const ERROR_MATCHERS_TRAIT = "com.distilled.openapi#errorMatchers";
+const RAW_RESPONSE_TRAIT = "com.distilled.openapi#rawResponse";
+const SENSITIVE_TRAIT = "smithy.api#sensitive";
+
+/** Meilisearch's provider spec for the shared smithy→SDK compiler. */
+const meilisearchSpec: SdkSpec = {
+ nullableTrait: NULLABLE_TRAIT,
+ errorMatchersTrait: ERROR_MATCHERS_TRAIT,
+
+ extraBindings: [
+ {
+ // Sole member of a synthesized wrapper for bare array/scalar response
+ // bodies; as the response's only member, the response IS the payload.
+ trait: RAW_RESPONSE_TRAIT,
+ binding: "rawResponse",
+ pipe: "T.RawResponse()",
+ rootPipe: "T.RawResponseRoot()",
+ },
+ ],
+
+ // Sensitive strings (API keys): the schema member carries T.SensitiveValue;
+ // the REST protocol delivers Redacted values and accepts string | Redacted
+ // on input.
+ memberTraitPipes: {
+ [SENSITIVE_TRAIT]: "T.SensitiveValue",
+ },
+ memberTsType: (m) =>
+ SENSITIVE_TRAIT in m.traits
+ ? `string | Redacted.Redacted${m.nullable ? " | null" : ""}`
+ : undefined,
+
+ // Unions surface as TS type unions over an opaque schema — the REST
+ // protocol passes union content through verbatim (wire names ARE the TS
+ // names), so no runtime case discrimination is needed.
+ union: ({ name, caseTargets, tsRef }) => [
+ `export type ${name} = ${caseTargets.map(tsRef).join(" | ") || "unknown"};`,
+ `export const ${name} = /*@__PURE__*/ S.Unknown as any as S.Schema<${name}>;\n`,
+ ],
+
+ // One pagination profile: Meilisearch's cursor mode (`from` in, `next`
+ // out), traversed by core's paginateCursor.
+ paginationProfiles: {
+ cursor: {
+ strategy: "paginateCursor",
+ itemsFallback: "results",
+ },
+ },
+
+ operationDecl: {
+ contextType: "MeilisearchOpContext",
+ commonErrorType: "MeilisearchOpError",
+ commonErrorClasses: ["UnknownMeilisearchError"],
+ protocol: "MeilisearchProtocol",
+ retry: "Retry.Retry",
+ },
+
+ sourceNote: ".generated-specs (specs/spec-mirror-meilisearch)",
+
+ // Sensitive member types reference Redacted; pull the import in when used.
+ postProcess: (code) =>
+ code.includes("Redacted.Redacted<")
+ ? code.replace(
+ `import * as S from "@distilled.cloud/core/schema";\n`,
+ `import * as S from "@distilled.cloud/core/schema";\nimport * as Redacted from "effect/Redacted";\n`,
+ )
+ : code,
+};
+
+runGeneratorCli({
+ description: "Generate the Meilisearch Effect SDK from the Smithy model",
+ root: `${import.meta.dir}/..`,
+ // patches/ holds OpenAPI-document patches consumed by scripts/convert.ts;
+ // there is no smithy-model patch chain.
+ patchesDir: false,
+ spec: () => meilisearchSpec,
+});
diff --git a/packages/meilisearch/src/credentials.ts b/packages/meilisearch/src/credentials.ts
new file mode 100644
index 000000000..21f0cba6e
--- /dev/null
+++ b/packages/meilisearch/src/credentials.ts
@@ -0,0 +1,57 @@
+/**
+ * Meilisearch credentials — hand-written.
+ *
+ * The `Credentials` service holds an *effect* that resolves the current
+ * credentials on every request (the protocol layer resolves it per request
+ * on the calling fiber). Auth is a bearer API key (master key or a key
+ * created via `/keys`).
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import { ConfigError } from "@distilled.cloud/core/errors";
+
+export const DEFAULT_API_BASE_URL = "http://localhost:7700";
+
+export interface Config {
+ readonly apiKey: Redacted.Redacted;
+ readonly apiBaseUrl: string;
+}
+
+export class Credentials extends Context.Service<
+ Credentials,
+ Effect.Effect
+>()("MeilisearchCredentials") {}
+
+/** Layer from a plain API key + optional base URL. */
+export const fromApiKey = (config: {
+ readonly apiKey: string;
+ readonly apiBaseUrl?: string;
+}): Layer.Layer =>
+ Layer.succeed(
+ Credentials,
+ Effect.succeed({
+ apiKey: Redacted.make(config.apiKey),
+ apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
+ }),
+ );
+
+/** Reads MEILISEARCH_API_KEY (required) and MEILISEARCH_API_BASE_URL (optional). */
+export const CredentialsFromEnv: Layer.Layer = Layer.succeed(
+ Credentials,
+ Effect.gen(function* () {
+ const apiKey = process.env.MEILISEARCH_API_KEY;
+
+ if (!apiKey) {
+ return yield* new ConfigError({
+ message: "MEILISEARCH_API_KEY environment variable is required",
+ });
+ }
+
+ return {
+ apiKey: Redacted.make(apiKey),
+ apiBaseUrl: process.env.MEILISEARCH_API_BASE_URL ?? DEFAULT_API_BASE_URL,
+ };
+ }).pipe(Effect.orDie),
+);
diff --git a/packages/meilisearch/src/errors.ts b/packages/meilisearch/src/errors.ts
new file mode 100644
index 000000000..678fd0ff7
--- /dev/null
+++ b/packages/meilisearch/src/errors.ts
@@ -0,0 +1,50 @@
+/**
+ * Meilisearch-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds the Meilisearch
+ * fallback errors. Note the generated service module additionally defines
+ * its own per-status matcher classes (BadRequest/NotFound/…) for the
+ * statuses each operation declares — those share `_tag`s with the core
+ * classes here, so `catchTag` works against either.
+ */
+export {
+ BadGateway,
+ BadRequest,
+ Conflict,
+ ConfigError,
+ Forbidden,
+ GatewayTimeout,
+ InternalServerError,
+ Locked,
+ NotFound,
+ ServiceUnavailable,
+ TooManyRequests,
+ Unauthorized,
+ UnprocessableEntity,
+ HTTP_STATUS_MAP,
+ DEFAULT_ERRORS,
+ API_ERRORS,
+} from "@distilled.cloud/core/errors";
+export type { DefaultErrors } from "@distilled.cloud/core/errors";
+
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+
+/** Unknown Meilisearch error — returned when nothing else matches the failure. */
+export class UnknownMeilisearchError extends Schema.TaggedError()(
+ "UnknownMeilisearchError",
+ {
+ code: Schema.optional(Schema.String),
+ message: Schema.optional(Schema.String),
+ body: Schema.Unknown,
+ },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class MeilisearchParseError extends Schema.TaggedError()(
+ "MeilisearchParseError",
+ {
+ body: Schema.Unknown,
+ cause: Schema.Unknown,
+ },
+).pipe(Category.withParseError) {}
diff --git a/packages/meilisearch/src/index.ts b/packages/meilisearch/src/index.ts
new file mode 100644
index 000000000..b29c6ece7
--- /dev/null
+++ b/packages/meilisearch/src/index.ts
@@ -0,0 +1,27 @@
+/**
+ * @distilled.cloud/meilisearch — Meilisearch SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy model
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * spec). Everything else in this folder is hand-written.
+ *
+ * @example
+ * ```ts
+ * import * as Meilisearch from "@distilled.cloud/meilisearch";
+ *
+ * const indexes = yield* Meilisearch.Services.meilisearch.listIndexes({});
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+ MeilisearchProtocol,
+ type MeilisearchOpError,
+ type MeilisearchOpContext,
+} from "./protocol.ts";
+export { paginateCursor } from "./pagination.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+export * from "./services/meilisearch.ts";
+export { BadRequest, NotFound } from "./services/meilisearch.ts";
diff --git a/packages/meilisearch/src/pagination.ts b/packages/meilisearch/src/pagination.ts
new file mode 100644
index 000000000..fa8af6873
--- /dev/null
+++ b/packages/meilisearch/src/pagination.ts
@@ -0,0 +1,8 @@
+/**
+ * Meilisearch pagination — hand-written.
+ *
+ * Meilisearch's task/batch list operations are cursor-mode (`from` in,
+ * `next` out); generated operations pass core's {@link paginateCursor}
+ * strategy to `API.makePaginated`.
+ */
+export { paginateCursor } from "@distilled.cloud/core/pagination";
diff --git a/packages/meilisearch/src/protocol.ts b/packages/meilisearch/src/protocol.ts
new file mode 100644
index 000000000..f3c72b157
--- /dev/null
+++ b/packages/meilisearch/src/protocol.ts
@@ -0,0 +1,68 @@
+/**
+ * MeilisearchProtocol — hand-written.
+ *
+ * Meilisearch speaks plain bearer-authenticated JSON REST (no response
+ * envelope), so the whole protocol is one `makeRestProtocol` call from
+ * `core/protocol-rest`:
+ *
+ * request: credentials → `Authorization: Bearer ` + base URL
+ * (default http://localhost:7700), resolved from the calling
+ * fiber on every request
+ *
+ * response: 2xx JSON is the payload (sensitive members delivered as
+ * `Redacted`); non-2xx `{ code?, message }` bodies map to the
+ * operation's typed error classes by status, then the shared
+ * HTTP-status classes, then {@link UnknownMeilisearchError}.
+ */
+import * as Effect from "effect/Effect";
+import type * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import type * as HttpClient from "effect/unstable/http/HttpClient";
+import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as API from "@distilled.cloud/core/api";
+import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
+import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
+import { Credentials, type Config } from "./credentials.ts";
+import { UnknownMeilisearchError } from "./errors.ts";
+
+/**
+ * Error channel shared by every generated Meilisearch operation. Generated
+ * service files annotate operations with `API.OperationMethod` explicitly so the compiler
+ * never infers these back out of the schema generics.
+ */
+export type MeilisearchOpError =
+ | InstanceType<(typeof API_ERRORS)[number]>
+ | UnknownMeilisearchError
+ | ConfigError
+ | HttpClientError.HttpClientError;
+
+/** Context (requirements) shared by every generated Meilisearch operation. */
+export type MeilisearchOpContext = Credentials | HttpClient.HttpClient;
+
+export const MeilisearchProtocol: Layer.Layer =
+ makeRestProtocol({
+ // The Credentials service holds an effect — resolving it here (per
+ // request, on the calling fiber) picks up context-provided credentials.
+ credentials: Effect.gen(function* () {
+ const resolve = yield* Credentials;
+ return yield* resolve;
+ }),
+ baseUrl: (creds) => creds.apiBaseUrl,
+ headers: (creds) => ({
+ Authorization: `Bearer ${Redacted.value(creds.apiKey)}`,
+ }),
+ // Meilisearch's error body is `{ message, code, type, link }` — the
+ // factory's default lenient envelope covers `code`/`message`.
+ unknownError: ({ code, message, body }) =>
+ new UnknownMeilisearchError({
+ code:
+ typeof code === "string"
+ ? code
+ : code !== undefined
+ ? String(code)
+ : undefined,
+ message,
+ body,
+ }),
+ });
diff --git a/packages/meilisearch/src/retry.ts b/packages/meilisearch/src/retry.ts
new file mode 100644
index 000000000..666ec5414
--- /dev/null
+++ b/packages/meilisearch/src/retry.ts
@@ -0,0 +1,56 @@
+/**
+ * Meilisearch retry configuration.
+ *
+ * Defines the per-SDK `Retry` Context.Service tag that generated operations
+ * wire into `API.make`. Callers can install a blanket retry policy at the
+ * layer level and have every Meilisearch API call below it pick it up:
+ *
+ * @example
+ * ```ts
+ * import * as Meilisearch from "@distilled.cloud/meilisearch";
+ *
+ * myEffect.pipe(Meilisearch.Retry.transient);
+ * Effect.provide(myEffect, Layer.succeed(Meilisearch.Retry.Retry, customPolicy));
+ * ```
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import {
+ type Policy,
+ throttlingFactory,
+ transientFactory,
+} from "@distilled.cloud/core/retry";
+
+export {
+ type Options,
+ type Factory,
+ type Policy,
+ makeDefault,
+ jittered,
+ capped,
+ throttlingOptions,
+ transientOptions,
+ throttlingFactory,
+ transientFactory,
+} from "@distilled.cloud/core/retry";
+
+/** Context tag for configuring retry behavior of Meilisearch API calls. */
+export class Retry extends Context.Service()(
+ "MeilisearchRetry",
+) {}
+
+/** Provides a custom retry policy to every Meilisearch API call below it. */
+export const policy = (optionsOrFactory: Policy) =>
+ Effect.provide(Layer.succeed(Retry, optionsOrFactory));
+
+/** Disables all automatic retries. */
+export const none = Effect.provide(
+ Layer.succeed(Retry, { while: () => false }),
+);
+
+/** Apply the throttling retry policy (retries throttling errors indefinitely). */
+export const throttling = policy(throttlingFactory);
+
+/** Apply the transient retry policy (retries all transient errors indefinitely). */
+export const transient = policy(transientFactory);
diff --git a/packages/meilisearch/src/services/index.ts b/packages/meilisearch/src/services/index.ts
new file mode 100644
index 000000000..a695d0dd6
--- /dev/null
+++ b/packages/meilisearch/src/services/index.ts
@@ -0,0 +1,2 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as meilisearch from "./meilisearch.ts";
diff --git a/packages/meilisearch/src/services/meilisearch.ts b/packages/meilisearch/src/services/meilisearch.ts
new file mode 100644
index 000000000..154a17b75
--- /dev/null
+++ b/packages/meilisearch/src/services/meilisearch.ts
@@ -0,0 +1,11616 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-meilisearch). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as Redacted from "effect/Redacted";
+import * as API from "@distilled.cloud/core/api";
+import * as C from "@distilled.cloud/core/category";
+import * as T from "../traits.ts";
+import {
+ MeilisearchProtocol,
+ type MeilisearchOpError,
+ type MeilisearchOpContext,
+} from "../protocol.ts";
+import { UnknownMeilisearchError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { MeilisearchOpError, MeilisearchOpContext };
+
+export class BadRequest
+ extends /*@__PURE__*/ T.applyErrorMatchers(
+ /*@__PURE__*/ S.TaggedError()("BadRequest", {
+ code: S.Number,
+ message: S.String,
+ }).pipe(C.withBadRequestError),
+ [{ status: 400 }],
+ ) {}
+
+export class NotFound
+ extends /*@__PURE__*/ T.applyErrorMatchers(
+ /*@__PURE__*/ S.TaggedError()("NotFound", {
+ code: S.Number,
+ message: S.String,
+ }).pipe(C.withBadRequestError),
+ [{ status: 404 }],
+ ) {}
+
+export interface CancelLogsRequest {}
+export const CancelLogsRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}).pipe(
+ T.Http({ method: "DELETE", uri: "/logs/stream", code: 200 }),
+ ),
+).annotate({
+ identifier: "CancelLogsRequest",
+}) as any as S.Schema;
+
+export interface CancelLogsResponse {}
+export const CancelLogsResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "CancelLogsResponse",
+}) as any as S.Schema;
+
+export type CancelTasksRequestUidsList = Array;
+export const CancelTasksRequestUidsList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+export type CancelTasksRequestBatchUidsList = Array;
+export const CancelTasksRequestBatchUidsList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+export type CancelTasksRequestCanceledByList = Array;
+export const CancelTasksRequestCanceledByList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+/** The type of the task. */
+export type Kind =
+ | "documentAdditionOrUpdate"
+ | "documentEdition"
+ | "documentDeletion"
+ | "settingsUpdate"
+ | "indexCreation"
+ | "indexDeletion"
+ | "indexUpdate"
+ | "indexSwap"
+ | "taskCancelation"
+ | "taskDeletion"
+ | "dumpCreation"
+ | "snapshotCreation"
+ | "export"
+ | "upgradeDatabase"
+ | "indexCompaction"
+ | "networkTopologyChange"
+ | "dsrUpdate"
+ | "dsrClear";
+export const Kind = /*@__PURE__*/ S.String;
+
+export type CancelTasksRequestTypesList = Array;
+export const CancelTasksRequestTypesList = /*@__PURE__*/ S.Array(
+ Kind,
+) as any as S.Schema;
+
+/** The status of a task. */
+export type Status =
+ | "enqueued"
+ | "processing"
+ | "succeeded"
+ | "failed"
+ | "canceled";
+export const Status = /*@__PURE__*/ S.String;
+
+export type CancelTasksRequestStatusesList = Array;
+export const CancelTasksRequestStatusesList = /*@__PURE__*/ S.Array(
+ Status,
+) as any as S.Schema;
+
+export type CancelTasksRequestIndexUidsList = Array;
+export const CancelTasksRequestIndexUidsList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+export interface CancelTasksRequest {
+ /** Permits to select tasks by their uid. When the `uids` query parameter is set to `*`, all task uids included. It's possible to specify several uids by separating them with the `,` character. */
+ uids?: CancelTasksRequestUidsList;
+ /** Lets you filter tasks by their `batchUid`. */
+ batchUids?: CancelTasksRequestBatchUidsList;
+ /** Permits to filter tasks using the uid of the task that canceled them. It's possible to specify several task uids by separating them with the `,` character. */
+ canceledBy?: CancelTasksRequestCanceledByList;
+ /** Permits to filter tasks by their related type. By default, when `types` query parameter is not set, all task types are returned. It's possible to specify several types by separating them with the `,` character. */
+ types?: CancelTasksRequestTypesList;
+ /** Permits to filter tasks by their status. By default, when `statuses` query parameter is not set, all task statuses are returned. It's possible to specify several statuses by separating them with the `,` character. */
+ statuses?: CancelTasksRequestStatusesList;
+ /** Permits to filter tasks by their related index. By default, when `indexUids` query parameter is not set, the tasks of all the indexes are returned. It is possible to specify several indexes by separating them with the `,` character. */
+ indexUids?: CancelTasksRequestIndexUidsList;
+ /** Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued after the given date. Supports RFC 3339 date format. */
+ afterEnqueuedAt?: string;
+ /** Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued before the given date. Supports RFC 3339 date format. */
+ beforeEnqueuedAt?: string;
+ /** Permits to filter tasks based on their startedAt time. Matches tasks started after the given date. Supports RFC 3339 date format. */
+ afterStartedAt?: string;
+ /** Permits to filter tasks based on their startedAt time. Matches tasks started before the given date. Supports RFC 3339 date format. */
+ beforeStartedAt?: string;
+ /** Permits to filter tasks based on their finishedAt time. Matches tasks finished after the given date. Supports RFC 3339 date format. */
+ afterFinishedAt?: string;
+ /** Permits to filter tasks based on their finishedAt time. Matches tasks finished before the given date. Supports RFC 3339 date format. */
+ beforeFinishedAt?: string;
+}
+export const CancelTasksRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ uids: S.optional(CancelTasksRequestUidsList.pipe(T.Query())),
+ batchUids: S.optional(CancelTasksRequestBatchUidsList.pipe(T.Query())),
+ canceledBy: S.optional(CancelTasksRequestCanceledByList.pipe(T.Query())),
+ types: S.optional(CancelTasksRequestTypesList.pipe(T.Query())),
+ statuses: S.optional(CancelTasksRequestStatusesList.pipe(T.Query())),
+ indexUids: S.optional(CancelTasksRequestIndexUidsList.pipe(T.Query())),
+ afterEnqueuedAt: S.optional(S.String.pipe(T.Query())),
+ beforeEnqueuedAt: S.optional(S.String.pipe(T.Query())),
+ afterStartedAt: S.optional(S.String.pipe(T.Query())),
+ beforeStartedAt: S.optional(S.String.pipe(T.Query())),
+ afterFinishedAt: S.optional(S.String.pipe(T.Query())),
+ beforeFinishedAt: S.optional(S.String.pipe(T.Query())),
+ }).pipe(T.Http({ method: "POST", uri: "/tasks/cancel", code: 200 })),
+).annotate({
+ identifier: "CancelTasksRequest",
+}) as any as S.Schema;
+
+/** A summarized view of a task, returned when a task is enqueued */
+export interface SummarizedTaskView {
+ /** Unique sequential identifier of the task. */
+ taskUid: number;
+ /** Unique identifier of the targeted index. Null for global tasks. */
+ indexUid?: string | null;
+ /** Status of the task. Possible values are `enqueued`, `processing`, `succeeded`, `failed`, and `canceled`. */
+ status: Status;
+ /** Type of operation performed by the task. */
+ type: Kind;
+ /** Date and time when the task was enqueued. */
+ enqueuedAt: string;
+ /** Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information. */
+ customMetadata?: string | null;
+}
+export const SummarizedTaskView = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ taskUid: S.Number,
+ indexUid: S.optional(S.NullOr(S.String)),
+ status: Status,
+ type: Kind,
+ enqueuedAt: S.String,
+ customMetadata: S.optional(S.NullOr(S.String)),
+ }),
+).annotate({
+ identifier: "SummarizedTaskView",
+}) as any as S.Schema;
+
+/** A text content part of a message. */
+export interface ChatCompletionRequestMessageContentPartText {
+ text: string;
+}
+export const ChatCompletionRequestMessageContentPartText =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ text: S.String,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestMessageContentPartText",
+ }) as any as S.Schema;
+
+export type ChatCompletionRequestDeveloperMessageContentCase1List =
+ Array;
+export const ChatCompletionRequestDeveloperMessageContentCase1List =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionRequestMessageContentPartText,
+ ) as any as S.Schema;
+
+/** The contents of a developer message: either a text string or an array of text content parts. */
+export type ChatCompletionRequestDeveloperMessageContent =
+ | string
+ | ChatCompletionRequestDeveloperMessageContentCase1List;
+export const ChatCompletionRequestDeveloperMessageContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase0Role = "developer";
+export const ChatCompletionRequestMessageCase0Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase0 {
+ /** The contents of the developer message. */
+ content: ChatCompletionRequestDeveloperMessageContent;
+ /** An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
+ name?: string | null;
+ role: ChatCompletionRequestMessageCase0Role;
+}
+export const ChatCompletionRequestMessageCase0 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: ChatCompletionRequestDeveloperMessageContent,
+ name: S.optional(S.NullOr(S.String)),
+ role: ChatCompletionRequestMessageCase0Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase0",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestSystemMessageContentPartType = "text";
+export const ChatCompletionRequestSystemMessageContentPartType =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestSystemMessageContentPart {
+ text: string;
+ type: ChatCompletionRequestSystemMessageContentPartType | (string & {});
+}
+export const ChatCompletionRequestSystemMessageContentPart =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ text: S.String,
+ type: ChatCompletionRequestSystemMessageContentPartType,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestSystemMessageContentPart",
+ }) as any as S.Schema;
+
+/** An array of content parts with a defined type. For system messages, only type `text` is supported. */
+export type ChatCompletionRequestSystemMessageContentCase1List =
+ Array;
+export const ChatCompletionRequestSystemMessageContentCase1List =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionRequestSystemMessageContentPart,
+ ) as any as S.Schema;
+
+/** The contents of a system message: either a text string or an array of text content parts. */
+export type ChatCompletionRequestSystemMessageContent =
+ | string
+ | ChatCompletionRequestSystemMessageContentCase1List;
+export const ChatCompletionRequestSystemMessageContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase1Role = "system";
+export const ChatCompletionRequestMessageCase1Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase1 {
+ /** The contents of the system message. */
+ content: ChatCompletionRequestSystemMessageContent;
+ /** An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
+ name?: string | null;
+ role: ChatCompletionRequestMessageCase1Role;
+}
+export const ChatCompletionRequestMessageCase1 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: ChatCompletionRequestSystemMessageContent,
+ name: S.optional(S.NullOr(S.String)),
+ role: ChatCompletionRequestMessageCase1Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase1",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestUserMessageContentPartCase0Type = "text";
+export const ChatCompletionRequestUserMessageContentPartCase0Type =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestUserMessageContentPartCase0 {
+ text: string;
+ type: ChatCompletionRequestUserMessageContentPartCase0Type;
+}
+export const ChatCompletionRequestUserMessageContentPartCase0 =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ text: S.String,
+ type: ChatCompletionRequestUserMessageContentPartCase0Type,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestUserMessageContentPartCase0",
+ }) as any as S.Schema;
+
+/** Specifies the detail level of the image. */
+export type ImageDetail = "auto" | "low" | "high";
+export const ImageDetail = /*@__PURE__*/ S.String;
+
+/** An image URL with optional detail level. */
+export interface ImageUrl {
+ /** Either a URL of the image or the base64 encoded image data. */
+ url: string;
+ detail?: ImageDetail | (string & {}) | null;
+}
+export const ImageUrl = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ url: S.String,
+ detail: S.optional(S.NullOr(ImageDetail)),
+ }),
+).annotate({ identifier: "ImageUrl" }) as any as S.Schema;
+
+export type ChatCompletionRequestUserMessageContentPartCase1Type = "image_url";
+export const ChatCompletionRequestUserMessageContentPartCase1Type =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestUserMessageContentPartCase1 {
+ image_url: ImageUrl;
+ type: ChatCompletionRequestUserMessageContentPartCase1Type;
+}
+export const ChatCompletionRequestUserMessageContentPartCase1 =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ image_url: ImageUrl,
+ type: ChatCompletionRequestUserMessageContentPartCase1Type,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestUserMessageContentPartCase1",
+ }) as any as S.Schema;
+
+/** The format of the encoded audio data. */
+export type InputAudioFormat = "wav" | "mp3";
+export const InputAudioFormat = /*@__PURE__*/ S.String;
+
+/** Input audio data for an audio content part. */
+export interface InputAudio {
+ /** Base64 encoded audio data. */
+ data: string;
+ /** The format of the encoded audio data. Currently supports "wav" and "mp3". */
+ format: InputAudioFormat | (string & {});
+}
+export const InputAudio = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ data: S.String,
+ format: InputAudioFormat,
+ }),
+).annotate({ identifier: "InputAudio" }) as any as S.Schema;
+
+export type ChatCompletionRequestUserMessageContentPartCase2Type =
+ "input_audio";
+export const ChatCompletionRequestUserMessageContentPartCase2Type =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestUserMessageContentPartCase2 {
+ input_audio: InputAudio;
+ type: ChatCompletionRequestUserMessageContentPartCase2Type;
+}
+export const ChatCompletionRequestUserMessageContentPartCase2 =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ input_audio: InputAudio,
+ type: ChatCompletionRequestUserMessageContentPartCase2Type,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestUserMessageContentPartCase2",
+ }) as any as S.Schema;
+
+/** A content part in a user message (text, image, or audio). */
+export type ChatCompletionRequestUserMessageContentPart =
+ | ChatCompletionRequestUserMessageContentPartCase0
+ | ChatCompletionRequestUserMessageContentPartCase1
+ | ChatCompletionRequestUserMessageContentPartCase2;
+export const ChatCompletionRequestUserMessageContentPart =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text, image, or audio inputs. */
+export type ChatCompletionRequestUserMessageContentCase1List =
+ Array;
+export const ChatCompletionRequestUserMessageContentCase1List =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionRequestUserMessageContentPart,
+ ) as any as S.Schema;
+
+/** The contents of a user message: either a text string or an array of content parts (text, image, or audio). */
+export type ChatCompletionRequestUserMessageContent =
+ | string
+ | ChatCompletionRequestUserMessageContentCase1List;
+export const ChatCompletionRequestUserMessageContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase2Role = "user";
+export const ChatCompletionRequestMessageCase2Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase2 {
+ /** The contents of the user message. */
+ content: ChatCompletionRequestUserMessageContent;
+ /** An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
+ name?: string | null;
+ role: ChatCompletionRequestMessageCase2Role;
+}
+export const ChatCompletionRequestMessageCase2 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: ChatCompletionRequestUserMessageContent,
+ name: S.optional(S.NullOr(S.String)),
+ role: ChatCompletionRequestMessageCase2Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase2",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestAssistantMessageContentPartCase0Type = "text";
+export const ChatCompletionRequestAssistantMessageContentPartCase0Type =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestAssistantMessageContentPartCase0 {
+ text: string;
+ type: ChatCompletionRequestAssistantMessageContentPartCase0Type;
+}
+export const ChatCompletionRequestAssistantMessageContentPartCase0 =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ text: S.String,
+ type: ChatCompletionRequestAssistantMessageContentPartCase0Type,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestAssistantMessageContentPartCase0",
+ }) as any as S.Schema;
+
+export type ChatCompletionRequestAssistantMessageContentPartCase1Type =
+ "refusal";
+export const ChatCompletionRequestAssistantMessageContentPartCase1Type =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestAssistantMessageContentPartCase1 {
+ /** The refusal message generated by the model. */
+ refusal: string;
+ type: ChatCompletionRequestAssistantMessageContentPartCase1Type;
+}
+export const ChatCompletionRequestAssistantMessageContentPartCase1 =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ refusal: S.String,
+ type: ChatCompletionRequestAssistantMessageContentPartCase1Type,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestAssistantMessageContentPartCase1",
+ }) as any as S.Schema;
+
+/** A content part in an assistant message (text or refusal). */
+export type ChatCompletionRequestAssistantMessageContentPart =
+ | ChatCompletionRequestAssistantMessageContentPartCase0
+ | ChatCompletionRequestAssistantMessageContentPartCase1;
+export const ChatCompletionRequestAssistantMessageContentPart =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. */
+export type ChatCompletionRequestAssistantMessageContentCase1List =
+ Array;
+export const ChatCompletionRequestAssistantMessageContentCase1List =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionRequestAssistantMessageContentPart,
+ ) as any as S.Schema;
+
+/** The contents of an assistant message: either a text string or an array of content parts (text or refusal). */
+export type ChatCompletionRequestAssistantMessageContent =
+ | string
+ | ChatCompletionRequestAssistantMessageContentCase1List;
+export const ChatCompletionRequestAssistantMessageContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** Data about a previous audio response from the model, used in multi-turn conversations. */
+export interface ChatCompletionRequestAssistantMessageAudio {
+ /** Unique identifier for a previous audio response from the model. */
+ id: string;
+}
+export const ChatCompletionRequestAssistantMessageAudio =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ id: S.String,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestAssistantMessageAudio",
+ }) as any as S.Schema;
+
+/** The type of a tool. Currently, only `function` is supported. */
+export type ChatCompletionToolType = "function";
+export const ChatCompletionToolType = /*@__PURE__*/ S.String;
+
+/** The name and arguments of a function that should be called, as generated by the model. */
+export interface FunctionCall {
+ /** The name of the function to call. */
+ name: string;
+ /** The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. */
+ arguments: string;
+}
+export const FunctionCall = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ name: S.String,
+ arguments: S.String,
+ }),
+).annotate({ identifier: "FunctionCall" }) as any as S.Schema;
+
+/** A tool call generated by the model. */
+export interface ChatCompletionMessageToolCall {
+ /** The ID of the tool call. */
+ id: string;
+ type?: ChatCompletionToolType | (string & {}) | null;
+ /** The function that the model called. */
+ function: FunctionCall;
+}
+export const ChatCompletionMessageToolCall = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ id: S.String,
+ type: S.optional(S.NullOr(ChatCompletionToolType)),
+ function: FunctionCall,
+ }),
+).annotate({
+ identifier: "ChatCompletionMessageToolCall",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase3ToolCallsList =
+ Array;
+export const ChatCompletionRequestMessageCase3ToolCallsList =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionMessageToolCall,
+ ) as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase3Role = "assistant";
+export const ChatCompletionRequestMessageCase3Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase3 {
+ content?: ChatCompletionRequestAssistantMessageContent | null;
+ /** The refusal message by the assistant. */
+ refusal?: string | null;
+ /** An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
+ name?: string | null;
+ audio?: ChatCompletionRequestAssistantMessageAudio | null;
+ tool_calls?: ChatCompletionRequestMessageCase3ToolCallsList | null;
+ function_call?: FunctionCall | null;
+ role: ChatCompletionRequestMessageCase3Role;
+}
+export const ChatCompletionRequestMessageCase3 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: S.optional(S.NullOr(ChatCompletionRequestAssistantMessageContent)),
+ refusal: S.optional(S.NullOr(S.String)),
+ name: S.optional(S.NullOr(S.String)),
+ audio: S.optional(S.NullOr(ChatCompletionRequestAssistantMessageAudio)),
+ tool_calls: S.optional(
+ S.NullOr(ChatCompletionRequestMessageCase3ToolCallsList),
+ ),
+ function_call: S.optional(S.NullOr(FunctionCall)),
+ role: ChatCompletionRequestMessageCase3Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase3",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestToolMessageContentPartType = "text";
+export const ChatCompletionRequestToolMessageContentPartType =
+ /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestToolMessageContentPart {
+ text: string;
+ type: ChatCompletionRequestToolMessageContentPartType | (string & {});
+}
+export const ChatCompletionRequestToolMessageContentPart =
+ /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ text: S.String,
+ type: ChatCompletionRequestToolMessageContentPartType,
+ }),
+ ).annotate({
+ identifier: "ChatCompletionRequestToolMessageContentPart",
+ }) as any as S.Schema;
+
+/** An array of content parts with a defined type. For tool messages, only type `text` is supported. */
+export type ChatCompletionRequestToolMessageContentCase1List =
+ Array;
+export const ChatCompletionRequestToolMessageContentCase1List =
+ /*@__PURE__*/ S.Array(
+ ChatCompletionRequestToolMessageContentPart,
+ ) as any as S.Schema;
+
+/** The contents of a tool message: either a text string or an array of text content parts. */
+export type ChatCompletionRequestToolMessageContent =
+ | string
+ | ChatCompletionRequestToolMessageContentCase1List;
+export const ChatCompletionRequestToolMessageContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase4Role = "tool";
+export const ChatCompletionRequestMessageCase4Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase4 {
+ /** The contents of the tool message. */
+ content: ChatCompletionRequestToolMessageContent;
+ tool_call_id: string;
+ role: ChatCompletionRequestMessageCase4Role;
+}
+export const ChatCompletionRequestMessageCase4 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: ChatCompletionRequestToolMessageContent,
+ tool_call_id: S.String,
+ role: ChatCompletionRequestMessageCase4Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase4",
+}) as any as S.Schema;
+
+export type ChatCompletionRequestMessageCase5Role = "function";
+export const ChatCompletionRequestMessageCase5Role = /*@__PURE__*/ S.String;
+
+export interface ChatCompletionRequestMessageCase5 {
+ /** The return value from the function call, to return to the model. */
+ content?: string | null;
+ /** The name of the function to call. */
+ name: string;
+ role: ChatCompletionRequestMessageCase5Role;
+}
+export const ChatCompletionRequestMessageCase5 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: S.optional(S.NullOr(S.String)),
+ name: S.String,
+ role: ChatCompletionRequestMessageCase5Role,
+ }),
+).annotate({
+ identifier: "ChatCompletionRequestMessageCase5",
+}) as any as S.Schema;
+
+/** A message in the chat completion conversation. Tagged by `role` (system, user, assistant, tool, developer, or function). */
+export type ChatCompletionRequestMessage =
+ | ChatCompletionRequestMessageCase0
+ | ChatCompletionRequestMessageCase1
+ | ChatCompletionRequestMessageCase2
+ | ChatCompletionRequestMessageCase3
+ | ChatCompletionRequestMessageCase4
+ | ChatCompletionRequestMessageCase5;
+export const ChatCompletionRequestMessage =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** A list of messages comprising the conversation so far. Depending on the [model](https://platform.openai.com/docs/models) you use, different message types (modalities) are supported, like [text](https://platform.openai.com/docs/guides/text-generation), [images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio). */
+export type ChatRequestMessagesList = Array;
+export const ChatRequestMessagesList = /*@__PURE__*/ S.Array(
+ ChatCompletionRequestMessage,
+) as any as S.Schema;
+
+/** Constrains effort on reasoning for reasoning models. Supported values are `low`, `medium`, and `high`. */
+export type ReasoningEffort = "low" | "medium" | "high";
+export const ReasoningEffort = /*@__PURE__*/ S.String;
+
+/** Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. */
+export type ChatRequestLogitBiasMap = { [key: string]: unknown | undefined };
+export const ChatRequestLogitBiasMap = /*@__PURE__*/ S.Record(
+ S.String,
+ S.Unknown,
+) as any as S.Schema;
+
+/** Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `["text"]` The `gpt-4o-audio-preview` model can also be used to [generate audio](https://platform.openai.com/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `["text", "audio"]` */
+export type ChatCompletionModalities = "text" | "audio";
+export const ChatCompletionModalities = /*@__PURE__*/ S.String;
+
+/** Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `["text"]`. */
+export type ChatRequestModalitiesList = Array<
+ ChatCompletionModalities | (string & {})
+>;
+export const ChatRequestModalitiesList = /*@__PURE__*/ S.Array(
+ ChatCompletionModalities,
+) as any as S.Schema;
+
+/** An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs. */
+export type PredictionContentContentCase1List =
+ Array;
+export const PredictionContentContentCase1List = /*@__PURE__*/ S.Array(
+ ChatCompletionRequestMessageContentPartText,
+) as any as S.Schema;
+
+/** The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly. */
+export type PredictionContentContent =
+ | string
+ | PredictionContentContentCase1List;
+export const PredictionContentContent =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+export type PredictionContentType = "content";
+export const PredictionContentType = /*@__PURE__*/ S.String;
+
+/** The type of the predicted content you want to provide. This type is currently always `content`. */
+export interface PredictionContent {
+ /** The type of the predicted content you want to provide. This type is currently always `content`. */
+ content: PredictionContentContent;
+ type: PredictionContentType | (string & {});
+}
+export const PredictionContent = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: PredictionContentContent,
+ type: PredictionContentType,
+ }),
+).annotate({
+ identifier: "PredictionContent",
+}) as any as S.Schema;
+
+/** The voice the model uses to respond in audio output. */
+export type ChatCompletionAudioVoice =
+ | "alloy"
+ | "ash"
+ | "ballad"
+ | "coral"
+ | "echo"
+ | "sage"
+ | "shimmer"
+ | "verse";
+export const ChatCompletionAudioVoice = /*@__PURE__*/ S.String;
+
+/** Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`. */
+export type ChatCompletionAudioFormat =
+ | "wav"
+ | "mp3"
+ | "flac"
+ | "opus"
+ | "pcm16";
+export const ChatCompletionAudioFormat = /*@__PURE__*/ S.String;
+
+/** Parameters for audio output. Required when audio output is requested with `modalities: ["audio"]`. */
+export interface ChatCompletionAudio {
+ /** The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive). */
+ voice: ChatCompletionAudioVoice | (string & {});
+ /** Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`. */
+ format: ChatCompletionAudioFormat | (string & {});
+}
+export const ChatCompletionAudio = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ voice: ChatCompletionAudioVoice,
+ format: ChatCompletionAudioFormat,
+ }),
+).annotate({
+ identifier: "ChatCompletionAudio",
+}) as any as S.Schema;
+
+export type ResponseFormatCase0Type = "text";
+export const ResponseFormatCase0Type = /*@__PURE__*/ S.String;
+
+/** The type of response format being defined: `text` */
+export interface ResponseFormatCase0 {
+ type: ResponseFormatCase0Type;
+}
+export const ResponseFormatCase0 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ type: ResponseFormatCase0Type,
+ }),
+).annotate({
+ identifier: "ResponseFormatCase0",
+}) as any as S.Schema;
+
+export type ResponseFormatCase1Type = "json_object";
+export const ResponseFormatCase1Type = /*@__PURE__*/ S.String;
+
+/** The type of response format being defined: `json_object` */
+export interface ResponseFormatCase1 {
+ type: ResponseFormatCase1Type;
+}
+export const ResponseFormatCase1 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ type: ResponseFormatCase1Type,
+ }),
+).annotate({
+ identifier: "ResponseFormatCase1",
+}) as any as S.Schema;
+
+/** A JSON Schema-based response format specification for Structured Outputs. */
+export interface ResponseFormatJsonSchema {
+ /** A description of what the response format is for, used by the model to determine how to respond in the format. */
+ description?: string | null;
+ /** The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
+ name: string;
+ /** The schema for the response format, described as a JSON Schema object. */
+ schema?: unknown;
+ /** Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). */
+ strict?: boolean | null;
+}
+export const ResponseFormatJsonSchema = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ description: S.optional(S.NullOr(S.String)),
+ name: S.String,
+ schema: S.optional(S.Unknown),
+ strict: S.optional(S.NullOr(S.Boolean)),
+ }),
+).annotate({
+ identifier: "ResponseFormatJsonSchema",
+}) as any as S.Schema;
+
+export type ResponseFormatCase2Type = "json_schema";
+export const ResponseFormatCase2Type = /*@__PURE__*/ S.String;
+
+/** The type of response format being defined: `json_schema` */
+export interface ResponseFormatCase2 {
+ json_schema: ResponseFormatJsonSchema;
+ type: ResponseFormatCase2Type;
+}
+export const ResponseFormatCase2 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ json_schema: ResponseFormatJsonSchema,
+ type: ResponseFormatCase2Type,
+ }),
+).annotate({
+ identifier: "ResponseFormatCase2",
+}) as any as S.Schema;
+
+/** An object specifying the format that the model must output (text, JSON object, or JSON schema). */
+export type ResponseFormat =
+ | ResponseFormatCase0
+ | ResponseFormatCase1
+ | ResponseFormatCase2;
+export const ResponseFormat =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** Specifies the latency tier to use for processing the request. */
+export type ServiceTier = "auto" | "default";
+export const ServiceTier = /*@__PURE__*/ S.String;
+
+export type StopCase1List = Array;
+export const StopCase1List = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+/** Up to 4 sequences where the API will stop generating further tokens. */
+export type Stop = string | StopCase1List;
+export const Stop = /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** Options for streaming response. Only set this when you set `stream: true`. */
+export interface ChatCompletionStreamOptions {
+ /** If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. */
+ include_usage: boolean;
+}
+export const ChatCompletionStreamOptions = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ include_usage: S.Boolean,
+ }),
+).annotate({
+ identifier: "ChatCompletionStreamOptions",
+}) as any as S.Schema;
+
+/** A function definition for tool use, described as a JSON Schema object. */
+export interface FunctionObject {
+ /** The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
+ name: string;
+ /** A description of what the function does, used by the model to choose when and how to call the function. */
+ description?: string | null;
+ /** The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. */
+ parameters?: unknown;
+ /** Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). */
+ strict?: boolean | null;
+}
+export const FunctionObject = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ name: S.String,
+ description: S.optional(S.NullOr(S.String)),
+ parameters: S.optional(S.Unknown),
+ strict: S.optional(S.NullOr(S.Boolean)),
+ }),
+).annotate({ identifier: "FunctionObject" }) as any as S.Schema;
+
+/** A tool the model may call. Currently, only functions are supported as a tool. */
+export interface ChatCompletionTool {
+ type: ChatCompletionToolType | (string & {});
+ function: FunctionObject;
+}
+export const ChatCompletionTool = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ type: ChatCompletionToolType,
+ function: FunctionObject,
+ }),
+).annotate({
+ identifier: "ChatCompletionTool",
+}) as any as S.Schema;
+
+/** A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. */
+export type ChatRequestToolsList = Array;
+export const ChatRequestToolsList = /*@__PURE__*/ S.Array(
+ ChatCompletionTool,
+) as any as S.Schema;
+
+export type ChatCompletionToolChoiceOptionCase0 = "none";
+export const ChatCompletionToolChoiceOptionCase0 = /*@__PURE__*/ S.String;
+
+export type ChatCompletionToolChoiceOptionCase1 = "auto";
+export const ChatCompletionToolChoiceOptionCase1 = /*@__PURE__*/ S.String;
+
+export type ChatCompletionToolChoiceOptionCase2 = "required";
+export const ChatCompletionToolChoiceOptionCase2 = /*@__PURE__*/ S.String;
+
+/** A wrapper for a function name reference. */
+export interface FunctionName {
+ /** The name of the function to call. */
+ name: string;
+}
+export const FunctionName = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ name: S.String,
+ }),
+).annotate({ identifier: "FunctionName" }) as any as S.Schema;
+
+/** Specifies a tool the model should use. Use to force the model to call a specific function. */
+export interface ChatCompletionNamedToolChoice {
+ /** The type of the tool. Currently, only `function` is supported. */
+ type: ChatCompletionToolType | (string & {});
+ function: FunctionName;
+}
+export const ChatCompletionNamedToolChoice = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ type: ChatCompletionToolType,
+ function: FunctionName,
+ }),
+).annotate({
+ identifier: "ChatCompletionNamedToolChoice",
+}) as any as S.Schema;
+
+export interface ChatCompletionToolChoiceOptionCase3 {
+ named: ChatCompletionNamedToolChoice;
+}
+export const ChatCompletionToolChoiceOptionCase3 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ named: ChatCompletionNamedToolChoice,
+ }),
+).annotate({
+ identifier: "ChatCompletionToolChoiceOptionCase3",
+}) as any as S.Schema;
+
+/** Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.present. */
+export type ChatCompletionToolChoiceOption =
+ | ChatCompletionToolChoiceOptionCase0
+ | ChatCompletionToolChoiceOptionCase1
+ | ChatCompletionToolChoiceOptionCase2
+ | ChatCompletionToolChoiceOptionCase3;
+export const ChatCompletionToolChoiceOption =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** The model does not call a function, and responds to the end-user. */
+export type ChatCompletionFunctionCallCase0 = "none";
+export const ChatCompletionFunctionCallCase0 = /*@__PURE__*/ S.String;
+
+/** The model can pick between an end-user or calling a function. */
+export type ChatCompletionFunctionCallCase1 = "auto";
+export const ChatCompletionFunctionCallCase1 = /*@__PURE__*/ S.String;
+
+/** Forces the model to call the specified function. */
+export interface ChatCompletionFunctionCallCase2Function {
+ name: string;
+}
+export const ChatCompletionFunctionCallCase2Function = /*@__PURE__*/ S.suspend(
+ () =>
+ S.Struct({
+ name: S.String,
+ }),
+).annotate({
+ identifier: "ChatCompletionFunctionCallCase2Function",
+}) as any as S.Schema;
+
+/** Forces the model to call the specified function. */
+export interface ChatCompletionFunctionCallCase2 {
+ /** Forces the model to call the specified function. */
+ Function: ChatCompletionFunctionCallCase2Function;
+}
+export const ChatCompletionFunctionCallCase2 = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ Function: ChatCompletionFunctionCallCase2Function,
+ }),
+).annotate({
+ identifier: "ChatCompletionFunctionCallCase2",
+}) as any as S.Schema;
+
+/** Deprecated in favor of `tool_choice`. Controls which (if any) function is called by the model. */
+export type ChatCompletionFunctionCall =
+ | ChatCompletionFunctionCallCase0
+ | ChatCompletionFunctionCallCase1
+ | ChatCompletionFunctionCallCase2;
+export const ChatCompletionFunctionCall =
+ /*@__PURE__*/ S.Unknown as any as S.Schema;
+
+/** Deprecated: A function the model may generate JSON inputs for. Use `ChatCompletionTool` instead. */
+export interface ChatCompletionFunctions {
+ /** The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
+ name: string;
+ /** A description of what the function does, used by the model to choose when and how to call the function. */
+ description?: string | null;
+ /** The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. */
+ parameters: unknown;
+}
+export const ChatCompletionFunctions = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ name: S.String,
+ description: S.optional(S.NullOr(S.String)),
+ parameters: S.Unknown,
+ }),
+).annotate({
+ identifier: "ChatCompletionFunctions",
+}) as any as S.Schema;
+
+/** Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. */
+export type ChatRequestFunctionsList = Array;
+export const ChatRequestFunctionsList = /*@__PURE__*/ S.Array(
+ ChatCompletionFunctions,
+) as any as S.Schema;
+
+export interface ChatRequest {
+ /** The unique identifier of the chat workspace. */
+ workspace_uid: string;
+ /** A list of messages comprising the conversation so far. Depending on the [model](https://platform.openai.com/docs/models) you use, different message types (modalities) are supported, like [text](https://platform.openai.com/docs/guides/text-generation), [images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio). */
+ messages: ChatRequestMessagesList;
+ /** ID of the model to use. See the [model endpoint compatibility](https://platform.openai.com/docs/models#model-endpoint-compatibility) table for details on which models work with the Chat API. */
+ model: string;
+ /** Whether or not to store the output of this chat completion request for use in our [model distillation](https://platform.openai.com/docs/guides/distillation) or [evals](https://platform.openai.com/docs/guides/evals) products. */
+ store?: boolean | null;
+ reasoning_effort?: ReasoningEffort | (string & {}) | null;
+ /** Developer-defined tags and values used for filtering completions in the [dashboard](https://platform.openai.com/chat-completions). */
+ metadata?: unknown;
+ /** Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. */
+ frequency_penalty?: number | null;
+ /** Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. */
+ logit_bias?: ChatRequestLogitBiasMap | null;
+ /** Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. */
+ logprobs?: boolean | null;
+ /** An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. */
+ top_logprobs?: number | null;
+ /** The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with [o1 series models](https://platform.openai.com/docs/guides/reasoning). */
+ max_tokens?: number | null;
+ /** An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). */
+ max_completion_tokens?: number | null;
+ /** How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. */
+ n?: number | null;
+ /** Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default: `["text"]`. */
+ modalities?: ChatRequestModalitiesList | null;
+ prediction?: PredictionContent | null;
+ audio?: ChatCompletionAudio | null;
+ /** Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. */
+ presence_penalty?: number | null;
+ response_format?: ResponseFormat | null;
+ /** This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. */
+ seed?: number | null;
+ service_tier?: ServiceTier | (string & {}) | null;
+ stop?: Stop | null;
+ /** If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). */
+ stream?: boolean | null;
+ stream_options?: ChatCompletionStreamOptions | null;
+ /** What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. */
+ temperature?: number | null;
+ /** An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. */
+ top_p?: number | null;
+ /** A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. */
+ tools?: ChatRequestToolsList | null;
+ tool_choice?: ChatCompletionToolChoiceOption | null;
+ /** Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling) during tool use. */
+ parallel_tool_calls?: boolean | null;
+ /** A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). */
+ user?: string | null;
+ function_call?: ChatCompletionFunctionCall | null;
+ /** Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. */
+ functions?: ChatRequestFunctionsList | null;
+}
+export const ChatRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ workspace_uid: S.String.pipe(T.Label()),
+ messages: ChatRequestMessagesList,
+ model: S.String,
+ store: S.optional(S.NullOr(S.Boolean)),
+ reasoning_effort: S.optional(S.NullOr(ReasoningEffort)),
+ metadata: S.optional(S.Unknown),
+ frequency_penalty: S.optional(S.NullOr(S.Number)),
+ logit_bias: S.optional(S.NullOr(ChatRequestLogitBiasMap)),
+ logprobs: S.optional(S.NullOr(S.Boolean)),
+ top_logprobs: S.optional(S.NullOr(S.Number)),
+ max_tokens: S.optional(S.NullOr(S.Number)),
+ max_completion_tokens: S.optional(S.NullOr(S.Number)),
+ n: S.optional(S.NullOr(S.Number)),
+ modalities: S.optional(S.NullOr(ChatRequestModalitiesList)),
+ prediction: S.optional(S.NullOr(PredictionContent)),
+ audio: S.optional(S.NullOr(ChatCompletionAudio)),
+ presence_penalty: S.optional(S.NullOr(S.Number)),
+ response_format: S.optional(S.NullOr(ResponseFormat)),
+ seed: S.optional(S.NullOr(S.Number)),
+ service_tier: S.optional(S.NullOr(ServiceTier)),
+ stop: S.optional(S.NullOr(Stop)),
+ stream: S.optional(S.NullOr(S.Boolean)),
+ stream_options: S.optional(S.NullOr(ChatCompletionStreamOptions)),
+ temperature: S.optional(S.NullOr(S.Number)),
+ top_p: S.optional(S.NullOr(S.Number)),
+ tools: S.optional(S.NullOr(ChatRequestToolsList)),
+ tool_choice: S.optional(S.NullOr(ChatCompletionToolChoiceOption)),
+ parallel_tool_calls: S.optional(S.NullOr(S.Boolean)),
+ user: S.optional(S.NullOr(S.String)),
+ function_call: S.optional(S.NullOr(ChatCompletionFunctionCall)),
+ functions: S.optional(S.NullOr(ChatRequestFunctionsList)),
+ }).pipe(
+ T.Http({
+ method: "POST",
+ uri: "/chats/{workspace_uid}/chat/completions",
+ code: 200,
+ }),
+ ),
+).annotate({ identifier: "ChatRequest" }) as any as S.Schema;
+
+/** The tool calls generated by the model, such as function calls. */
+export type ChatCompletionResponseMessageToolCallsList =
+ Array;
+export const ChatCompletionResponseMessageToolCallsList = /*@__PURE__*/ S.Array(
+ ChatCompletionMessageToolCall,
+) as any as S.Schema;
+
+/** The role of the author of a message. */
+export type Role = "system" | "user" | "assistant" | "tool" | "function";
+export const Role = /*@__PURE__*/ S.String;
+
+/** Audio data in a chat completion response message. */
+export interface ChatCompletionResponseMessageAudio {
+ /** Unique identifier for this audio response. */
+ id: string;
+ /** The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. */
+ expires_at: number;
+ /** Base64 encoded audio bytes generated by the model, in the format specified in the request. */
+ data: string;
+ /** Transcript of the audio generated by the model. */
+ transcript: string;
+}
+export const ChatCompletionResponseMessageAudio = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ id: S.String,
+ expires_at: S.Number,
+ data: S.String,
+ transcript: S.String,
+ }),
+).annotate({
+ identifier: "ChatCompletionResponseMessageAudio",
+}) as any as S.Schema;
+
+/** A chat completion message generated by the model. */
+export interface ChatCompletionResponseMessage {
+ /** The contents of the message. */
+ content?: string | null;
+ /** The refusal message generated by the model. */
+ refusal?: string | null;
+ /** The tool calls generated by the model, such as function calls. */
+ tool_calls?: ChatCompletionResponseMessageToolCallsList | null;
+ /** The role of the author of this message. */
+ role: Role;
+ function_call?: FunctionCall | null;
+ audio?: ChatCompletionResponseMessageAudio | null;
+}
+export const ChatCompletionResponseMessage = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: S.optional(S.NullOr(S.String)),
+ refusal: S.optional(S.NullOr(S.String)),
+ tool_calls: S.optional(
+ S.NullOr(ChatCompletionResponseMessageToolCallsList),
+ ),
+ role: Role,
+ function_call: S.optional(S.NullOr(FunctionCall)),
+ audio: S.optional(S.NullOr(ChatCompletionResponseMessageAudio)),
+ }),
+).annotate({
+ identifier: "ChatCompletionResponseMessage",
+}) as any as S.Schema;
+
+/** The reason the model stopped generating tokens. */
+export type FinishReason =
+ | "stop"
+ | "length"
+ | "tool_calls"
+ | "content_filter"
+ | "function_call";
+export const FinishReason = /*@__PURE__*/ S.String;
+
+/** A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. */
+export type ChatCompletionTokenLogprobBytesList = Array;
+export const ChatCompletionTokenLogprobBytesList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+/** A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. */
+export type TopLogprobsBytesList = Array;
+export const TopLogprobsBytesList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+/** A most likely token and its log probability at a given position. */
+export interface TopLogprobs {
+ /** The token. */
+ token: string;
+ /** The log probability of this token. */
+ logprob: number;
+ /** A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. */
+ bytes?: TopLogprobsBytesList | null;
+}
+export const TopLogprobs = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ token: S.String,
+ logprob: S.Number,
+ bytes: S.optional(S.NullOr(TopLogprobsBytesList)),
+ }),
+).annotate({ identifier: "TopLogprobs" }) as any as S.Schema;
+
+/** List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. */
+export type ChatCompletionTokenLogprobTopLogprobsList = Array;
+export const ChatCompletionTokenLogprobTopLogprobsList = /*@__PURE__*/ S.Array(
+ TopLogprobs,
+) as any as S.Schema;
+
+/** Log probability information for an output token. */
+export interface ChatCompletionTokenLogprob {
+ /** The token. */
+ token: string;
+ /** The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. */
+ logprob: number;
+ /** A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. */
+ bytes?: ChatCompletionTokenLogprobBytesList | null;
+ /** List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. */
+ top_logprobs: ChatCompletionTokenLogprobTopLogprobsList;
+}
+export const ChatCompletionTokenLogprob = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ token: S.String,
+ logprob: S.Number,
+ bytes: S.optional(S.NullOr(ChatCompletionTokenLogprobBytesList)),
+ top_logprobs: ChatCompletionTokenLogprobTopLogprobsList,
+ }),
+).annotate({
+ identifier: "ChatCompletionTokenLogprob",
+}) as any as S.Schema;
+
+/** A list of message content tokens with log probability information. */
+export type ChatChoiceLogprobsContentList = Array;
+export const ChatChoiceLogprobsContentList = /*@__PURE__*/ S.Array(
+ ChatCompletionTokenLogprob,
+) as any as S.Schema;
+
+export type ChatChoiceLogprobsRefusalList = Array;
+export const ChatChoiceLogprobsRefusalList = /*@__PURE__*/ S.Array(
+ ChatCompletionTokenLogprob,
+) as any as S.Schema;
+
+/** Log probability information for a chat completion choice. */
+export interface ChatChoiceLogprobs {
+ /** A list of message content tokens with log probability information. */
+ content?: ChatChoiceLogprobsContentList | null;
+ refusal?: ChatChoiceLogprobsRefusalList | null;
+}
+export const ChatChoiceLogprobs = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ content: S.optional(S.NullOr(ChatChoiceLogprobsContentList)),
+ refusal: S.optional(S.NullOr(ChatChoiceLogprobsRefusalList)),
+ }),
+).annotate({
+ identifier: "ChatChoiceLogprobs",
+}) as any as S.Schema;
+
+/** A chat completion choice generated by the model. */
+export interface ChatChoice {
+ /** The index of the choice in the list of choices. */
+ index: number;
+ message: ChatCompletionResponseMessage;
+ finish_reason?: FinishReason | null;
+ logprobs?: ChatChoiceLogprobs | null;
+}
+export const ChatChoice = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index: S.Number,
+ message: ChatCompletionResponseMessage,
+ finish_reason: S.optional(S.NullOr(FinishReason)),
+ logprobs: S.optional(S.NullOr(ChatChoiceLogprobs)),
+ }),
+).annotate({ identifier: "ChatChoice" }) as any as S.Schema;
+
+/** A list of chat completion choices. Can be more than one if `n` is greater than 1. */
+export type CreateChatCompletionResponseChoicesList = Array;
+export const CreateChatCompletionResponseChoicesList = /*@__PURE__*/ S.Array(
+ ChatChoice,
+) as any as S.Schema;
+
+/** The service tier used for processing the request, as returned in the response. */
+export type ServiceTierResponse = "scale" | "default" | "auto";
+export const ServiceTierResponse = /*@__PURE__*/ S.String;
+
+/** Breakdown of tokens used in a completion. */
+export interface PromptTokensDetails {
+ /** Audio input tokens present in the prompt. */
+ audio_tokens?: number | null;
+ /** Cached tokens present in the prompt. */
+ cached_tokens?: number | null;
+}
+export const PromptTokensDetails = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ audio_tokens: S.optional(S.NullOr(S.Number)),
+ cached_tokens: S.optional(S.NullOr(S.Number)),
+ }),
+).annotate({
+ identifier: "PromptTokensDetails",
+}) as any as S.Schema;
+
+/** Breakdown of tokens used in a completion. */
+export interface CompletionTokensDetails {
+ accepted_prediction_tokens?: number | null;
+ /** Audio input tokens generated by the model. */
+ audio_tokens?: number | null;
+ /** Tokens generated by the model for reasoning. */
+ reasoning_tokens?: number | null;
+ /** When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits. */
+ rejected_prediction_tokens?: number | null;
+}
+export const CompletionTokensDetails = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ accepted_prediction_tokens: S.optional(S.NullOr(S.Number)),
+ audio_tokens: S.optional(S.NullOr(S.Number)),
+ reasoning_tokens: S.optional(S.NullOr(S.Number)),
+ rejected_prediction_tokens: S.optional(S.NullOr(S.Number)),
+ }),
+).annotate({
+ identifier: "CompletionTokensDetails",
+}) as any as S.Schema;
+
+/** Usage statistics for the completion request. */
+export interface CompletionUsage {
+ /** Number of tokens in the prompt. */
+ prompt_tokens: number;
+ /** Number of tokens in the generated completion. */
+ completion_tokens: number;
+ /** Total number of tokens used in the request (prompt + completion). */
+ total_tokens: number;
+ prompt_tokens_details?: PromptTokensDetails | null;
+ completion_tokens_details?: CompletionTokensDetails | null;
+}
+export const CompletionUsage = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ prompt_tokens: S.Number,
+ completion_tokens: S.Number,
+ total_tokens: S.Number,
+ prompt_tokens_details: S.optional(S.NullOr(PromptTokensDetails)),
+ completion_tokens_details: S.optional(S.NullOr(CompletionTokensDetails)),
+ }),
+).annotate({
+ identifier: "CompletionUsage",
+}) as any as S.Schema;
+
+/** Represents a chat completion response returned by model, based on the provided input. */
+export interface CreateChatCompletionResponse {
+ /** A unique identifier for the chat completion. */
+ id: string;
+ /** A list of chat completion choices. Can be more than one if `n` is greater than 1. */
+ choices: CreateChatCompletionResponseChoicesList;
+ /** The Unix timestamp (in seconds) of when the chat completion was created. */
+ created: number;
+ /** The model used for the chat completion. */
+ model: string;
+ service_tier?: ServiceTierResponse | null;
+ /** This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. */
+ system_fingerprint?: string | null;
+ /** The object type, which is always `chat.completion`. */
+ object: string;
+ usage?: CompletionUsage | null;
+}
+export const CreateChatCompletionResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ id: S.String,
+ choices: CreateChatCompletionResponseChoicesList,
+ created: S.Number,
+ model: S.String,
+ service_tier: S.optional(S.NullOr(ServiceTierResponse)),
+ system_fingerprint: S.optional(S.NullOr(S.String)),
+ object: S.String,
+ usage: S.optional(S.NullOr(CompletionUsage)),
+ }),
+).annotate({
+ identifier: "CreateChatCompletionResponse",
+}) as any as S.Schema;
+
+export interface ClearAllDocumentsRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** A string that can be used to identify and filter tasks. This metadata is stored with the task and returned in task responses. Useful for tracking tasks from external systems or associating tasks with specific operations in your application. */
+ customMetadata?: string;
+}
+export const ClearAllDocumentsRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ customMetadata: S.optional(S.String.pipe(T.Query())),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/documents",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "ClearAllDocumentsRequest",
+}) as any as S.Schema;
+
+export interface ClearAllDocumentsResponse {}
+export const ClearAllDocumentsResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "ClearAllDocumentsResponse",
+}) as any as S.Schema;
+
+export interface ClearRulesRequest {}
+export const ClearRulesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}).pipe(
+ T.Http({ method: "DELETE", uri: "/dynamic-search-rules", code: 200 }),
+ ),
+).annotate({
+ identifier: "ClearRulesRequest",
+}) as any as S.Schema;
+
+export interface ClearRulesResponse {}
+export const ClearRulesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "ClearRulesResponse",
+}) as any as S.Schema;
+
+export interface CompactRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const CompactRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({ method: "POST", uri: "/indexes/{index_uid}/compact", code: 200 }),
+ ),
+).annotate({ identifier: "CompactRequest" }) as any as S.Schema;
+
+export interface CompactResponse {}
+export const CompactResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "CompactResponse",
+}) as any as S.Schema;
+
+export interface CompactTaskQueueRequest {}
+export const CompactTaskQueueRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}).pipe(
+ T.Http({ method: "POST", uri: "/tasks/compact", code: 200 }),
+ ),
+).annotate({
+ identifier: "CompactTaskQueueRequest",
+}) as any as S.Schema;
+
+export interface TaskCompactionSummary {
+ /** Size of the task queue database before compaction. */
+ preSize?: string;
+ /** Size of the task queue database after compaction. */
+ postSize?: string;
+ /** Outcome of the compaction operation. */
+ status: Status;
+ /** Follow-up action required after a successful compaction. */
+ actionRequired?: string | null;
+ /** Error message if compaction failed. */
+ errorMessage?: string | null;
+}
+export const TaskCompactionSummary = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ preSize: S.optional(S.String),
+ postSize: S.optional(S.String),
+ status: Status,
+ actionRequired: S.optional(S.NullOr(S.String)),
+ errorMessage: S.optional(S.NullOr(S.String)),
+ }),
+).annotate({
+ identifier: "TaskCompactionSummary",
+}) as any as S.Schema;
+
+export type Action =
+ | "*"
+ | "search"
+ | "documents.*"
+ | "documents.add"
+ | "documents.get"
+ | "documents.delete"
+ | "indexes.*"
+ | "indexes.create"
+ | "indexes.get"
+ | "indexes.update"
+ | "indexes.delete"
+ | "indexes.swap"
+ | "tasks.*"
+ | "tasks.cancel"
+ | "tasks.delete"
+ | "tasks.get"
+ | "settings.*"
+ | "settings.get"
+ | "settings.update"
+ | "stats.*"
+ | "stats.get"
+ | "metrics.*"
+ | "metrics.get"
+ | "dumps.*"
+ | "dumps.create"
+ | "snapshots.*"
+ | "snapshots.create"
+ | "version"
+ | "keys.create"
+ | "keys.get"
+ | "keys.update"
+ | "keys.delete"
+ | "experimental.get"
+ | "experimental.update"
+ | "export"
+ | "network.get"
+ | "network.update"
+ | "chatCompletions"
+ | "chats.*"
+ | "chats.get"
+ | "chats.delete"
+ | "chatsSettings.*"
+ | "chatsSettings.get"
+ | "chatsSettings.update"
+ | "*.get"
+ | "webhooks.get"
+ | "webhooks.update"
+ | "webhooks.delete"
+ | "webhooks.create"
+ | "webhooks.*"
+ | "indexes.compact"
+ | "fields.post"
+ | "tasks.compact"
+ | "dynamicSearchRules.get"
+ | "dynamicSearchRules.create"
+ | "dynamicSearchRules.update"
+ | "dynamicSearchRules.delete"
+ | "dynamicSearchRules.*";
+export const Action = /*@__PURE__*/ S.String;
+
+/** A list of actions permitted for the key. `["*"]` for all actions. The `*` character can be used as a wildcard when located at the last position. e.g. `documents.*` to authorize access on all documents endpoints. Valid actions include: `search`, `documents.add`, `documents.get`, `documents.delete`, `indexes.create`, `indexes.get`, `indexes.update`, `indexes.delete`, `indexes.swap`, `tasks.get`, `tasks.cancel`, `tasks.delete`, `settings.get`, `settings.update`, `stats.get`, `dumps.create`, `snapshots.create`, `version`, `keys.get`, `keys.create`, `keys.update`, `keys.delete`. Use `*` to grant all actions. */
+export type CreateApiKeyRequestActionsList = Array;
+export const CreateApiKeyRequestActionsList = /*@__PURE__*/ S.Array(
+ Action,
+) as any as S.Schema;
+
+/** A list of accessible indexes permitted for the key. `["*"]` for all indexes. The `*` character can be used as a wildcard when located at the last position. e.g. `products_*` to allow access to all indexes whose names start with `products_`. */
+export type CreateApiKeyRequestIndexesList = Array;
+export const CreateApiKeyRequestIndexesList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+export interface CreateApiKeyRequest {
+ /** A description for the key. `null` if empty. */
+ description?: string | null;
+ /** A human-readable name for the key. `null` if empty. */
+ name?: string | null;
+ /** A uuid v4 to identify the API Key. If not specified, it's generated by Meilisearch. */
+ uid?: string | null;
+ /** A list of actions permitted for the key. `["*"]` for all actions. The `*` character can be used as a wildcard when located at the last position. e.g. `documents.*` to authorize access on all documents endpoints. Valid actions include: `search`, `documents.add`, `documents.get`, `documents.delete`, `indexes.create`, `indexes.get`, `indexes.update`, `indexes.delete`, `indexes.swap`, `tasks.get`, `tasks.cancel`, `tasks.delete`, `settings.get`, `settings.update`, `stats.get`, `dumps.create`, `snapshots.create`, `version`, `keys.get`, `keys.create`, `keys.update`, `keys.delete`. Use `*` to grant all actions. */
+ actions: CreateApiKeyRequestActionsList;
+ /** A list of accessible indexes permitted for the key. `["*"]` for all indexes. The `*` character can be used as a wildcard when located at the last position. e.g. `products_*` to allow access to all indexes whose names start with `products_`. */
+ indexes: CreateApiKeyRequestIndexesList;
+ /** Represent the expiration date and time as RFC 3339 format. `null` equals to no expiration time. Set to `null` to create a key that never expires. Once a key is past its expiry date, using it returns an error. */
+ expiresAt: string | null;
+}
+export const CreateApiKeyRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ description: S.optional(S.NullOr(S.String)),
+ name: S.optional(S.NullOr(S.String)),
+ uid: S.optional(S.NullOr(S.String)),
+ actions: CreateApiKeyRequestActionsList,
+ indexes: CreateApiKeyRequestIndexesList,
+ expiresAt: S.NullOr(S.String),
+ }).pipe(T.Http({ method: "POST", uri: "/keys", code: 200 })),
+).annotate({
+ identifier: "CreateApiKeyRequest",
+}) as any as S.Schema;
+
+/** The list of actions (permissions) this key is allowed to perform. Examples include `documents.add`, `search`, `indexes.create`, `settings.update`, etc. Use `*` to grant all permissions. */
+export type KeyViewActionsList = Array;
+export const KeyViewActionsList = /*@__PURE__*/ S.Array(
+ Action,
+) as any as S.Schema;
+
+/** The list of index UIDs this key can access. Use `*` to grant access to all indexes, including future ones. Patterns are also supported, e.g., `movies_*` matches any index starting with "movies_". */
+export type KeyViewIndexesList = Array;
+export const KeyViewIndexesList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+/** Represents an API key used for authenticating requests to Meilisearch. Each key has specific permissions defined by its actions and can be scoped to particular indexes. Keys provide fine-grained access control for your Meilisearch instance. */
+export interface KeyView {
+ /** A human-readable name for the API key. Use this to identify the purpose of each key, such as "Frontend Search Key" or "Admin Key for CI/CD". This is optional and can be `null`. */
+ name?: string | null;
+ /** A longer description explaining the purpose or usage of this API key. Useful for documenting why the key was created and how it should be used. This is optional and can be `null`. */
+ description?: string | null;
+ /** The actual API key string to use in the `Authorization: Bearer ` header when making requests to Meilisearch. Keep this value secret and never expose it in client-side code. */
+ key: string;
+ /** The unique identifier (UUID) for this API key. Use this to update or delete the key. The UID remains constant even if the key's name or description changes. */
+ uid: string;
+ /** The list of actions (permissions) this key is allowed to perform. Examples include `documents.add`, `search`, `indexes.create`, `settings.update`, etc. Use `*` to grant all permissions. */
+ actions: KeyViewActionsList;
+ /** The list of index UIDs this key can access. Use `*` to grant access to all indexes, including future ones. Patterns are also supported, e.g., `movies_*` matches any index starting with "movies_". */
+ indexes: KeyViewIndexesList;
+ /** The expiration date and time of the key in RFC 3339 format. After this time, the key will no longer be valid for authentication. Set to `null` for keys that never expire. */
+ expiresAt?: string | null;
+ /** The date and time when this API key was created, formatted as an RFC 3339 date-time string. This is automatically set by Meilisearch and cannot be modified. */
+ createdAt: string;
+ /** The date and time when this API key was last modified, formatted as an RFC 3339 date-time string. This is automatically updated by Meilisearch when the key's name or description changes. */
+ updatedAt: string;
+}
+export const KeyView = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ name: S.optional(S.NullOr(S.String)),
+ description: S.optional(S.NullOr(S.String)),
+ key: S.String,
+ uid: S.String,
+ actions: KeyViewActionsList,
+ indexes: KeyViewIndexesList,
+ expiresAt: S.optional(S.NullOr(S.String)),
+ createdAt: S.String,
+ updatedAt: S.String,
+ }),
+).annotate({ identifier: "KeyView" }) as any as S.Schema;
+
+export interface CreateDumpRequest {}
+export const CreateDumpRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}).pipe(T.Http({ method: "POST", uri: "/dumps", code: 200 })),
+).annotate({
+ identifier: "CreateDumpRequest",
+}) as any as S.Schema;
+
+export interface CreateDumpResponse {}
+export const CreateDumpResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "CreateDumpResponse",
+}) as any as S.Schema;
+
+export interface CreateIndexRequest {
+ /** Unique identifier for the index */
+ uid: string;
+ /** [Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index */
+ primaryKey?: string | null;
+}
+export const CreateIndexRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ uid: S.String,
+ primaryKey: S.optional(S.NullOr(S.String)),
+ }).pipe(T.Http({ method: "POST", uri: "/indexes", code: 200 })),
+).annotate({
+ identifier: "CreateIndexRequest",
+}) as any as S.Schema;
+
+export interface CreateIndexResponse {}
+export const CreateIndexResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "CreateIndexResponse",
+}) as any as S.Schema;
+
+export interface CreateSnapshotRequest {}
+export const CreateSnapshotRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}).pipe(T.Http({ method: "POST", uri: "/snapshots", code: 200 })),
+).annotate({
+ identifier: "CreateSnapshotRequest",
+}) as any as S.Schema;
+
+export interface CreateSnapshotResponse {}
+export const CreateSnapshotResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "CreateSnapshotResponse",
+}) as any as S.Schema;
+
+export interface DeleteAllRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteAllRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteAllRequest",
+}) as any as S.Schema;
+
+export interface DeleteAllResponse {}
+export const DeleteAllResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteAllResponse",
+}) as any as S.Schema;
+
+export interface DeleteApiKeyRequest {
+ /** The `uid` or `key` field of an existing API key. */
+ key: string;
+}
+export const DeleteApiKeyRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ key: S.String.pipe(T.Label()),
+ }).pipe(T.Http({ method: "DELETE", uri: "/keys/{key}", code: 200 })),
+).annotate({
+ identifier: "DeleteApiKeyRequest",
+}) as any as S.Schema;
+
+export interface DeleteApiKeyResponse {}
+export const DeleteApiKeyResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteApiKeyResponse",
+}) as any as S.Schema;
+
+export interface DeletechatRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletechatRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/chat",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletechatRequest",
+}) as any as S.Schema;
+
+export interface DeletechatResponse {}
+export const DeletechatResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletechatResponse",
+}) as any as S.Schema;
+
+export interface DeleteChatRequest {
+ /** The unique identifier of the chat workspace. */
+ workspace_uid: string;
+}
+export const DeleteChatRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ workspace_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({ method: "DELETE", uri: "/chats/{workspace_uid}", code: 200 }),
+ ),
+).annotate({
+ identifier: "DeleteChatRequest",
+}) as any as S.Schema;
+
+export interface DeleteChatResponse {}
+export const DeleteChatResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteChatResponse",
+}) as any as S.Schema;
+
+export interface DeletedictionaryRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletedictionaryRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/dictionary",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletedictionaryRequest",
+}) as any as S.Schema;
+
+export interface DeletedictionaryResponse {}
+export const DeletedictionaryResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletedictionaryResponse",
+}) as any as S.Schema;
+
+export interface DeletedisplayedAttributesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletedisplayedAttributesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/displayed-attributes",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletedisplayedAttributesRequest",
+}) as any as S.Schema;
+
+export interface DeletedisplayedAttributesResponse {}
+export const DeletedisplayedAttributesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletedisplayedAttributesResponse",
+}) as any as S.Schema;
+
+export interface DeletedistinctAttributeRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletedistinctAttributeRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/distinct-attribute",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletedistinctAttributeRequest",
+}) as any as S.Schema;
+
+export interface DeletedistinctAttributeResponse {}
+export const DeletedistinctAttributeResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletedistinctAttributeResponse",
+}) as any as S.Schema;
+
+export interface DeleteDocumentRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** Document identifier. */
+ document_id: string;
+ /** A string that can be used to identify and filter tasks. This metadata is stored with the task and returned in task responses. Useful for tracking tasks from external systems or associating tasks with specific operations in your application. */
+ customMetadata?: string;
+}
+export const DeleteDocumentRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ document_id: S.String.pipe(T.Label()),
+ customMetadata: S.optional(S.String.pipe(T.Query())),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/documents/{document_id}",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteDocumentRequest",
+}) as any as S.Schema;
+
+export interface DeleteDocumentResponse {}
+export const DeleteDocumentResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteDocumentResponse",
+}) as any as S.Schema;
+
+export type DeleteDocumentsBatchRequestBodyList = Array;
+export const DeleteDocumentsBatchRequestBodyList = /*@__PURE__*/ S.Array(
+ S.Unknown,
+) as any as S.Schema;
+
+export interface DeleteDocumentsBatchRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** A string that can be used to identify and filter tasks. This metadata is stored with the task and returned in task responses. Useful for tracking tasks from external systems or associating tasks with specific operations in your application. */
+ customMetadata?: string;
+ body: DeleteDocumentsBatchRequestBodyList;
+}
+export const DeleteDocumentsBatchRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ customMetadata: S.optional(S.String.pipe(T.Query())),
+ body: DeleteDocumentsBatchRequestBodyList.pipe(T.HttpBody()),
+ }).pipe(
+ T.Http({
+ method: "POST",
+ uri: "/indexes/{index_uid}/documents/delete-batch",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteDocumentsBatchRequest",
+}) as any as S.Schema;
+
+export interface DeleteDocumentsBatchResponse {}
+export const DeleteDocumentsBatchResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteDocumentsBatchResponse",
+}) as any as S.Schema;
+
+export interface DeleteDocumentsByFilterRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** A string that can be used to identify and filter tasks. This metadata is stored with the task and returned in task responses. Useful for tracking tasks from external systems or associating tasks with specific operations in your application. */
+ customMetadata?: string;
+ /** Filter expression to match documents for deletion. Attributes must be in `filterableAttributes` before they can be used. Accepts a string or an array of arrays. Sending an empty filter will return a `bad_request` error. */
+ filter: unknown;
+}
+export const DeleteDocumentsByFilterRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ customMetadata: S.optional(S.String.pipe(T.Query())),
+ filter: S.Unknown,
+ }).pipe(
+ T.Http({
+ method: "POST",
+ uri: "/indexes/{index_uid}/documents/delete",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteDocumentsByFilterRequest",
+}) as any as S.Schema;
+
+export interface DeleteDocumentsByFilterResponse {}
+export const DeleteDocumentsByFilterResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteDocumentsByFilterResponse",
+}) as any as S.Schema;
+
+export interface DeleteembeddersRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteembeddersRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/embedders",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteembeddersRequest",
+}) as any as S.Schema;
+
+export interface DeleteembeddersResponse {}
+export const DeleteembeddersResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteembeddersResponse",
+}) as any as S.Schema;
+
+export interface DeletefacetingRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletefacetingRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/faceting",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletefacetingRequest",
+}) as any as S.Schema;
+
+export interface DeletefacetingResponse {}
+export const DeletefacetingResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletefacetingResponse",
+}) as any as S.Schema;
+
+export interface DeletefacetSearchRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletefacetSearchRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/facet-search",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletefacetSearchRequest",
+}) as any as S.Schema;
+
+export interface DeletefacetSearchResponse {}
+export const DeletefacetSearchResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletefacetSearchResponse",
+}) as any as S.Schema;
+
+export interface DeletefilterableAttributesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletefilterableAttributesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/filterable-attributes",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletefilterableAttributesRequest",
+}) as any as S.Schema;
+
+export interface DeletefilterableAttributesResponse {}
+export const DeletefilterableAttributesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletefilterableAttributesResponse",
+}) as any as S.Schema;
+
+export interface DeleteforeignKeysRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteforeignKeysRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/foreign-keys",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteforeignKeysRequest",
+}) as any as S.Schema;
+
+export interface DeleteforeignKeysResponse {}
+export const DeleteforeignKeysResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteforeignKeysResponse",
+}) as any as S.Schema;
+
+export interface DeleteIndexRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteIndexRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(T.Http({ method: "DELETE", uri: "/indexes/{index_uid}", code: 200 })),
+).annotate({
+ identifier: "DeleteIndexRequest",
+}) as any as S.Schema;
+
+export interface DeleteIndexResponse {}
+export const DeleteIndexResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteIndexResponse",
+}) as any as S.Schema;
+
+export interface DeletelocalizedAttributesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletelocalizedAttributesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/localized-attributes",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletelocalizedAttributesRequest",
+}) as any as S.Schema;
+
+export interface DeletelocalizedAttributesResponse {}
+export const DeletelocalizedAttributesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletelocalizedAttributesResponse",
+}) as any as S.Schema;
+
+export interface DeletenonSeparatorTokensRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletenonSeparatorTokensRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/non-separator-tokens",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletenonSeparatorTokensRequest",
+}) as any as S.Schema;
+
+export interface DeletenonSeparatorTokensResponse {}
+export const DeletenonSeparatorTokensResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletenonSeparatorTokensResponse",
+}) as any as S.Schema;
+
+export interface DeletepaginationRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletepaginationRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/pagination",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletepaginationRequest",
+}) as any as S.Schema;
+
+export interface DeletepaginationResponse {}
+export const DeletepaginationResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletepaginationResponse",
+}) as any as S.Schema;
+
+export interface DeleteprefixSearchRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteprefixSearchRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/prefix-search",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteprefixSearchRequest",
+}) as any as S.Schema;
+
+export interface DeleteprefixSearchResponse {}
+export const DeleteprefixSearchResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteprefixSearchResponse",
+}) as any as S.Schema;
+
+export interface DeleteproximityPrecisionRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteproximityPrecisionRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/proximity-precision",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteproximityPrecisionRequest",
+}) as any as S.Schema;
+
+export interface DeleteproximityPrecisionResponse {}
+export const DeleteproximityPrecisionResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteproximityPrecisionResponse",
+}) as any as S.Schema;
+
+export interface DeleterankingRulesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleterankingRulesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/ranking-rules",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleterankingRulesRequest",
+}) as any as S.Schema;
+
+export interface DeleterankingRulesResponse {}
+export const DeleterankingRulesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleterankingRulesResponse",
+}) as any as S.Schema;
+
+export interface DeleteRuleRequest {
+ /** Unique identifier of the search rule. */
+ uid: string;
+}
+export const DeleteRuleRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({ method: "DELETE", uri: "/dynamic-search-rules/{uid}", code: 200 }),
+ ),
+).annotate({
+ identifier: "DeleteRuleRequest",
+}) as any as S.Schema;
+
+export interface DeleteRuleResponse {}
+export const DeleteRuleResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteRuleResponse",
+}) as any as S.Schema;
+
+export interface DeletesearchableAttributesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletesearchableAttributesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/searchable-attributes",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletesearchableAttributesRequest",
+}) as any as S.Schema;
+
+export interface DeletesearchableAttributesResponse {}
+export const DeletesearchableAttributesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletesearchableAttributesResponse",
+}) as any as S.Schema;
+
+export interface DeletesearchCutoffMsRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletesearchCutoffMsRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/search-cutoff-ms",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletesearchCutoffMsRequest",
+}) as any as S.Schema;
+
+export interface DeletesearchCutoffMsResponse {}
+export const DeletesearchCutoffMsResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletesearchCutoffMsResponse",
+}) as any as S.Schema;
+
+export interface DeleteseparatorTokensRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeleteseparatorTokensRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/separator-tokens",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeleteseparatorTokensRequest",
+}) as any as S.Schema;
+
+export interface DeleteseparatorTokensResponse {}
+export const DeleteseparatorTokensResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteseparatorTokensResponse",
+}) as any as S.Schema;
+
+export interface DeletesortableAttributesRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletesortableAttributesRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/sortable-attributes",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletesortableAttributesRequest",
+}) as any as S.Schema;
+
+export interface DeletesortableAttributesResponse {}
+export const DeletesortableAttributesResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletesortableAttributesResponse",
+}) as any as S.Schema;
+
+export interface DeletestopWordsRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletestopWordsRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/stop-words",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletestopWordsRequest",
+}) as any as S.Schema;
+
+export interface DeletestopWordsResponse {}
+export const DeletestopWordsResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletestopWordsResponse",
+}) as any as S.Schema;
+
+export interface DeletesynonymsRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletesynonymsRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/synonyms",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletesynonymsRequest",
+}) as any as S.Schema;
+
+export interface DeletesynonymsResponse {}
+export const DeletesynonymsResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletesynonymsResponse",
+}) as any as S.Schema;
+
+export type DeleteTasksRequestUidsList = Array;
+export const DeleteTasksRequestUidsList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+export type DeleteTasksRequestBatchUidsList = Array;
+export const DeleteTasksRequestBatchUidsList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+export type DeleteTasksRequestCanceledByList = Array;
+export const DeleteTasksRequestCanceledByList = /*@__PURE__*/ S.Array(
+ S.Number,
+) as any as S.Schema;
+
+export type DeleteTasksRequestTypesList = Array;
+export const DeleteTasksRequestTypesList = /*@__PURE__*/ S.Array(
+ Kind,
+) as any as S.Schema;
+
+export type DeleteTasksRequestStatusesList = Array;
+export const DeleteTasksRequestStatusesList = /*@__PURE__*/ S.Array(
+ Status,
+) as any as S.Schema;
+
+export type DeleteTasksRequestIndexUidsList = Array;
+export const DeleteTasksRequestIndexUidsList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+export interface DeleteTasksRequest {
+ /** Permits to select tasks by their uid. When the `uids` query parameter is set to `*`, all task uids included. It's possible to specify several uids by separating them with the `,` character. */
+ uids?: DeleteTasksRequestUidsList;
+ /** Lets you filter tasks by their `batchUid`. */
+ batchUids?: DeleteTasksRequestBatchUidsList;
+ /** Permits to filter tasks using the uid of the task that canceled them. It's possible to specify several task uids by separating them with the `,` character. */
+ canceledBy?: DeleteTasksRequestCanceledByList;
+ /** Permits to filter tasks by their related type. By default, when `types` query parameter is not set, all task types are returned. It's possible to specify several types by separating them with the `,` character. */
+ types?: DeleteTasksRequestTypesList;
+ /** Permits to filter tasks by their status. By default, when `statuses` query parameter is not set, all task statuses are returned. It's possible to specify several statuses by separating them with the `,` character. */
+ statuses?: DeleteTasksRequestStatusesList;
+ /** Permits to filter tasks by their related index. By default, when `indexUids` query parameter is not set, the tasks of all the indexes are returned. It is possible to specify several indexes by separating them with the `,` character. */
+ indexUids?: DeleteTasksRequestIndexUidsList;
+ /** Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued after the given date. Supports RFC 3339 date format. */
+ afterEnqueuedAt?: string;
+ /** Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued before the given date. Supports RFC 3339 date format. */
+ beforeEnqueuedAt?: string;
+ /** Permits to filter tasks based on their startedAt time. Matches tasks started after the given date. Supports RFC 3339 date format. */
+ afterStartedAt?: string;
+ /** Permits to filter tasks based on their startedAt time. Matches tasks started before the given date. Supports RFC 3339 date format. */
+ beforeStartedAt?: string;
+ /** Permits to filter tasks based on their finishedAt time. Matches tasks finished after the given date. Supports RFC 3339 date format. */
+ afterFinishedAt?: string;
+ /** Permits to filter tasks based on their finishedAt time. Matches tasks finished before the given date. Supports RFC 3339 date format. */
+ beforeFinishedAt?: string;
+}
+export const DeleteTasksRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ uids: S.optional(DeleteTasksRequestUidsList.pipe(T.Query())),
+ batchUids: S.optional(DeleteTasksRequestBatchUidsList.pipe(T.Query())),
+ canceledBy: S.optional(DeleteTasksRequestCanceledByList.pipe(T.Query())),
+ types: S.optional(DeleteTasksRequestTypesList.pipe(T.Query())),
+ statuses: S.optional(DeleteTasksRequestStatusesList.pipe(T.Query())),
+ indexUids: S.optional(DeleteTasksRequestIndexUidsList.pipe(T.Query())),
+ afterEnqueuedAt: S.optional(S.String.pipe(T.Query())),
+ beforeEnqueuedAt: S.optional(S.String.pipe(T.Query())),
+ afterStartedAt: S.optional(S.String.pipe(T.Query())),
+ beforeStartedAt: S.optional(S.String.pipe(T.Query())),
+ afterFinishedAt: S.optional(S.String.pipe(T.Query())),
+ beforeFinishedAt: S.optional(S.String.pipe(T.Query())),
+ }).pipe(T.Http({ method: "DELETE", uri: "/tasks", code: 200 })),
+).annotate({
+ identifier: "DeleteTasksRequest",
+}) as any as S.Schema;
+
+export interface DeletetypoToleranceRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const DeletetypoToleranceRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({
+ method: "DELETE",
+ uri: "/indexes/{index_uid}/settings/typo-tolerance",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DeletetypoToleranceRequest",
+}) as any as S.Schema;
+
+export interface DeletetypoToleranceResponse {}
+export const DeletetypoToleranceResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeletetypoToleranceResponse",
+}) as any as S.Schema;
+
+export interface DeleteWebhookRequest {
+ /** Universally unique identifier of the webhook. */
+ uuid: string;
+}
+export const DeleteWebhookRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ uuid: S.String.pipe(T.Label()),
+ }).pipe(T.Http({ method: "DELETE", uri: "/webhooks/{uuid}", code: 200 })),
+).annotate({
+ identifier: "DeleteWebhookRequest",
+}) as any as S.Schema;
+
+export interface DeleteWebhookResponse {}
+export const DeleteWebhookResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "DeleteWebhookResponse",
+}) as any as S.Schema;
+
+/** Array of document attributes to include in the response. If not specified, all attributes listed in the `displayedAttributes` setting are returned. Use this to reduce response size by only requesting the fields you need. Example: `["title", "description", "price"]`. */
+export type DocumentsByQueryPostRequestFieldsList = Array;
+export const DocumentsByQueryPostRequestFieldsList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+/** Array of specific document IDs to retrieve. Only documents with matching [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values will be returned. If not specified, all documents matching other criteria are returned. This is useful for fetching specific known documents. */
+export type DocumentsByQueryPostRequestIdsList = Array;
+export const DocumentsByQueryPostRequestIdsList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+/** Array of attributes to sort the documents by. Each entry should be in the format `attribute:direction` where direction is either `asc` (ascending) or `desc` (descending). Example: `["price:asc", "rating:desc"]` sorts by price ascending, then by rating descending. */
+export type DocumentsByQueryPostRequestSortList = Array;
+export const DocumentsByQueryPostRequestSortList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+export interface DocumentsByQueryPostRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** Number of documents to skip in the response. Use together with `limit` for pagination through large document sets. For example, to get documents 151-170, set `offset=150` and `limit=20`. Defaults to `0`. */
+ offset?: number;
+ /** Maximum number of documents to return in a single response. Use together with `offset` for pagination. Higher values return more results but may increase response time and memory usage. Defaults to `20`. */
+ limit?: number;
+ /** Array of document attributes to include in the response. If not specified, all attributes listed in the `displayedAttributes` setting are returned. Use this to reduce response size by only requesting the fields you need. Example: `["title", "description", "price"]`. */
+ fields?: DocumentsByQueryPostRequestFieldsList | null;
+ /** When `true`, includes the vector embeddings in the response for documents that have them. This is useful when you need to inspect or export vector data. Note that this can significantly increase response size. Defaults to `false`. */
+ retrieveVectors?: boolean;
+ /** Array of specific document IDs to retrieve. Only documents with matching [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values will be returned. If not specified, all documents matching other criteria are returned. This is useful for fetching specific known documents. */
+ ids?: DocumentsByQueryPostRequestIdsList | null;
+ /** Filter expression to select which documents to return. Attributes must be added to the `filterableAttributes` index setting before they can be used in filters. Accepts a string or an array of arrays of strings for AND/OR combinations. Example string: `"genres = action AND rating > 4"`. Example array: `[["genres = action", "genres = comedy"], "rating > 4"]` (inner array = OR, outer = AND). */
+ filter?: unknown;
+ /** Array of attributes to sort the documents by. Each entry should be in the format `attribute:direction` where direction is either `asc` (ascending) or `desc` (descending). Example: `["price:asc", "rating:desc"]` sorts by price ascending, then by rating descending. */
+ sort?: DocumentsByQueryPostRequestSortList | null;
+ /** When `true`, runs the query on the whole network (all shards covered exactly once). When `false`, the query runs locally. When omitted or `null`, the default value depends on whether the sharding is enabled for the instance: - If the instance has sharding enabled (has a leader), defaults to `true`. - Otherwise defaults to `false`. It also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features). Values: `true` = use the whole network; `false` = local, default = see above. When using the network, the index must exist with compatible settings on all remotes. */
+ useNetwork?: boolean | null;
+}
+export const DocumentsByQueryPostRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ offset: S.optional(S.Number),
+ limit: S.optional(S.Number),
+ fields: S.optional(S.NullOr(DocumentsByQueryPostRequestFieldsList)),
+ retrieveVectors: S.optional(S.Boolean),
+ ids: S.optional(S.NullOr(DocumentsByQueryPostRequestIdsList)),
+ filter: S.optional(S.Unknown),
+ sort: S.optional(S.NullOr(DocumentsByQueryPostRequestSortList)),
+ useNetwork: S.optional(S.NullOr(S.Boolean)),
+ }).pipe(
+ T.Http({
+ method: "POST",
+ uri: "/indexes/{index_uid}/documents/fetch",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "DocumentsByQueryPostRequest",
+}) as any as S.Schema;
+
+/** Items for the current page. */
+export type PaginationViewValueResultsList = Array;
+export const PaginationViewValueResultsList = /*@__PURE__*/ S.Array(
+ S.Unknown,
+) as any as S.Schema;
+
+export interface PaginationViewValue {
+ /** Items for the current page. */
+ results: PaginationViewValueResultsList;
+ /** Number of items skipped. */
+ offset: number;
+ /** Maximum number of items returned. */
+ limit: number;
+ /** Total number of items matching the query. */
+ total: number;
+}
+export const PaginationViewValue = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ results: PaginationViewValueResultsList,
+ offset: S.Number,
+ limit: S.Number,
+ total: S.Number,
+ }),
+).annotate({
+ identifier: "PaginationViewValue",
+}) as any as S.Schema;
+
+export interface EditDocumentsByFunctionRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+ /** A string that can be used to identify and filter tasks. This metadata is stored with the task and returned in task responses. Useful for tracking tasks from external systems or associating tasks with specific operations in your application. */
+ customMetadata?: string;
+ /** Filter expression to select which documents to edit. If omitted, all documents in the index will be processed. Attributes must be in `filterableAttributes` to be used. */
+ filter?: unknown;
+ /** Arbitrary data to pass into the function scope. By default the function only has access to the current document being edited via the `doc` variable. */
+ context?: unknown;
+ /** A [RHAI](https://rhai.rs) function string to apply to each document. The function has access to a `doc` variable representing the current document. Modify `doc` fields to update the document. Return `null` or `()` to delete the document. To enable this feature: `PATCH /experimental-features/ {"editDocumentsByFunction": true}`. */
+ function: string;
+}
+export const EditDocumentsByFunctionRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ customMetadata: S.optional(S.String.pipe(T.Query())),
+ filter: S.optional(S.Unknown),
+ context: S.optional(S.Unknown),
+ function: S.String,
+ }).pipe(
+ T.Http({
+ method: "POST",
+ uri: "/indexes/{index_uid}/documents/edit",
+ code: 200,
+ }),
+ ),
+).annotate({
+ identifier: "EditDocumentsByFunctionRequest",
+}) as any as S.Schema;
+
+export interface EditDocumentsByFunctionResponse {}
+export const EditDocumentsByFunctionResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({
+ identifier: "EditDocumentsByFunctionResponse",
+}) as any as S.Schema;
+
+/** Export settings for a specific index */
+export interface ExportIndexSettings {
+ /** Filter expression to select which documents to export */
+ filter?: string | null;
+ /** Whether to override settings on the destination index */
+ overrideSettings?: boolean | null;
+}
+export const ExportIndexSettings = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ filter: S.optional(S.NullOr(S.String)),
+ overrideSettings: S.optional(S.NullOr(S.Boolean)),
+ }),
+).annotate({
+ identifier: "ExportIndexSettings",
+}) as any as S.Schema;
+
+/** Index patterns to export with their settings */
+export type ExportRequestIndexesMap = {
+ [key: string]: ExportIndexSettings | undefined;
+};
+export const ExportRequestIndexesMap = /*@__PURE__*/ S.Record(
+ S.String,
+ ExportIndexSettings,
+) as any as S.Schema;
+
+export interface ExportRequest {
+ /** URL of the destination Meilisearch instance */
+ url?: string;
+ /** API key for authenticating with the destination instance */
+ apiKey?: string | Redacted.Redacted | null;
+ /** Maximum payload size per request */
+ payloadSize?: string | null;
+ /** Index patterns to export with their settings */
+ indexes?: ExportRequestIndexesMap | null;
+}
+export const ExportRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ url: S.optional(S.String),
+ apiKey: S.optional(S.NullOr(S.String).pipe(T.SensitiveValue({}))),
+ payloadSize: S.optional(S.NullOr(S.String)),
+ indexes: S.optional(S.NullOr(ExportRequestIndexesMap)),
+ }).pipe(T.Http({ method: "POST", uri: "/export", code: 200 })),
+).annotate({ identifier: "ExportRequest" }) as any as S.Schema;
+
+export interface ExportResponse {}
+export const ExportResponse = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({}),
+).annotate({ identifier: "ExportResponse" }) as any as S.Schema;
+
+export interface GetAllRequest {
+ /** Unique identifier of the index. */
+ index_uid: string;
+}
+export const GetAllRequest = /*@__PURE__*/ S.suspend(() =>
+ S.Struct({
+ index_uid: S.String.pipe(T.Label()),
+ }).pipe(
+ T.Http({ method: "GET", uri: "/indexes/{index_uid}/settings", code: 200 }),
+ ),
+).annotate({ identifier: "GetAllRequest" }) as any as S.Schema;
+
+/** 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). */
+export type SettingsUncheckedDisplayedAttributesList = Array;
+export const SettingsUncheckedDisplayedAttributesList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema;
+
+/** 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). */
+export type SettingsUncheckedSearchableAttributesList = Array;
+export const SettingsUncheckedSearchableAttributesList = /*@__PURE__*/ S.Array(
+ S.String,
+) as any as S.Schema