Skip to main content
DELETE
/
indexes
/
{index_uid}
/
settings
/
proximity-precision
cURL
curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/proximity-precision'
client.index('books').resetProximityPrecision()
$client->index('books')->resetProximityPrecision();
client.index('books').reset_proximity_precision()
client.index("books").resetProximityPrecisionSettings();
client.index('books').reset_proximity_precision
client.Index("books").ResetProximityPrecision()
await client.Index("books").ResetProximityPrecisionAsync();
let task: TaskInfo = client
  .index("books")
  .reset_proximity_precision()
  .await
  .unwrap();
let task = try await self.client.index("books").resetProximityPrecision()
{
  "taskUid": 147,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-08-08T17:05:55.791772Z"
}
{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}
{
  "message": "Index `movies` not found.",
  "code": "index_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors#index_not_found"
}

Authorizations

​
Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Path Parameters

​
index_uid
string
required

Unique identifier of the index.

Response

Task successfully enqueued.

A summarized view of a task, returned when a task is enqueued

​
taskUid
integer<u-int32>
required

Unique sequential identifier of the task.

Required range: x >= 0
​
status
enum<string>
required

Status of the task. Possible values are enqueued, processing, succeeded, failed, and canceled.

Available options:
enqueued,
processing,
succeeded,
failed,
canceled
Example:

"processing"

​
type
enum<string>
required

Type of operation performed by the task.

Available options:
documentAdditionOrUpdate,
documentEdition,
documentDeletion,
settingsUpdate,
indexCreation,
indexDeletion,
indexUpdate,
indexSwap,
taskCancelation,
taskDeletion,
dumpCreation,
snapshotCreation,
export,
upgradeDatabase,
indexCompaction,
networkTopologyChange
Example:

"documentAdditionOrUpdate"

​
enqueuedAt
string<date-time>
required

Date and time when the task was enqueued.

​
indexUid
string | null

Unique identifier of the targeted index. Null for global tasks.

​
customMetadata
string | null

Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.