Skip to content

Models task

Task Models

Meilisearch processes writes asynchronously, so methods that modify data return a TaskInfo rather than the result of the write. The task_uid from that TaskInfo can be used to look up a TaskResult to find out whether the write succeeded. Batches group the tasks Meilisearch processed together.

Task Models API

meilisearch_python_sdk.models.task

TaskId

Bases: CamelBase

Source code in meilisearch_python_sdk/models/task.py 
11
12
class TaskId(CamelBase):
    uid: int

uid instance-attribute 

uid: int

TaskResult

Bases: TaskId

Source code in meilisearch_python_sdk/models/task.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class TaskResult(TaskId):
    index_uid: str | None = None
    status: str
    task_type: str | JsonDict = Field(..., alias="type")
    details: JsonDict | None = None
    error: JsonDict | None = None
    canceled_by: int | None = None
    duration: str | None = None
    enqueued_at: datetime
    started_at: datetime | None = None
    finished_at: datetime | None = None
    batch_uid: int | None = None
    custom_metadata: str | None = None

index_uid class-attribute instance-attribute 

index_uid: str | None = None

status instance-attribute 

status: str

task_type class-attribute instance-attribute 

task_type: str | JsonDict = Field(..., alias='type')

details class-attribute instance-attribute 

details: JsonDict | None = None

error class-attribute instance-attribute 

error: JsonDict | None = None

canceled_by class-attribute instance-attribute 

canceled_by: int | None = None

duration class-attribute instance-attribute 

duration: str | None = None

enqueued_at instance-attribute 

enqueued_at: datetime

started_at class-attribute instance-attribute 

started_at: datetime | None = None

finished_at class-attribute instance-attribute 

finished_at: datetime | None = None

batch_uid class-attribute instance-attribute 

batch_uid: int | None = None

custom_metadata class-attribute instance-attribute 

custom_metadata: str | None = None

TaskStatus

Bases: CamelBase

Source code in meilisearch_python_sdk/models/task.py 
30
31
32
33
34
35
class TaskStatus(CamelBase):
    results: list[TaskResult]
    total: int
    limit: int
    from_: int | None = Field(None, alias="from")
    next: int | None = None

results instance-attribute 

results: list[TaskResult]

total instance-attribute 

total: int

limit instance-attribute 

limit: int

from_ class-attribute instance-attribute 

from_: int | None = Field(None, alias='from')

next class-attribute instance-attribute 

next: int | None = None

TaskInfo

Bases: CamelBase

Source code in meilisearch_python_sdk/models/task.py 
38
39
40
41
42
43
44
45
class TaskInfo(CamelBase):
    task_uid: int
    index_uid: str | None = None
    status: str
    task_type: str | JsonDict = Field(..., alias="type")
    enqueued_at: datetime
    batch_uid: int | None = None
    custom_metadata: str | None = None

task_uid instance-attribute 

task_uid: int

index_uid class-attribute instance-attribute 

index_uid: str | None = None

status instance-attribute 

status: str

task_type class-attribute instance-attribute 

task_type: str | JsonDict = Field(..., alias='type')

enqueued_at instance-attribute 

enqueued_at: datetime

batch_uid class-attribute instance-attribute 

batch_uid: int | None = None

custom_metadata class-attribute instance-attribute 

custom_metadata: str | None = None

Batch Models API

meilisearch_python_sdk.models.batch

BatchId

Bases: CamelBase

Source code in meilisearch_python_sdk/models/batch.py 
11
12
class BatchId(CamelBase):
    uid: int

uid instance-attribute 

uid: int

Status

Bases: CamelBase

Source code in meilisearch_python_sdk/models/batch.py 
15
16
17
18
19
20
class Status(CamelBase):
    succeeded: int | None = None
    failed: int | None = None
    cancelled: int | None = None
    processing: int | None = None
    enqueued: int | None = None

succeeded class-attribute instance-attribute 

succeeded: int | None = None

failed class-attribute instance-attribute 

failed: int | None = None

cancelled class-attribute instance-attribute 

cancelled: int | None = None

processing class-attribute instance-attribute 

processing: int | None = None

enqueued class-attribute instance-attribute 

enqueued: int | None = None

Stats

Bases: CamelBase

Source code in meilisearch_python_sdk/models/batch.py 
23
24
25
26
27
28
29
30
class Stats(CamelBase):
    total_nb_tasks: int
    status: Status
    batch_types: JsonDict | None = Field(None, alias="types")
    index_uids: JsonDict | None = None
    progress_trace: JsonDict | None = None
    write_channel_congestion: JsonDict | None = None
    internal_database_sizes: JsonDict | None = None

total_nb_tasks instance-attribute 

total_nb_tasks: int

status instance-attribute 

status: Status

batch_types class-attribute instance-attribute 

batch_types: JsonDict | None = Field(None, alias='types')

index_uids class-attribute instance-attribute 

index_uids: JsonDict | None = None

progress_trace class-attribute instance-attribute 

progress_trace: JsonDict | None = None

write_channel_congestion class-attribute instance-attribute 

write_channel_congestion: JsonDict | None = None

internal_database_sizes class-attribute instance-attribute 

internal_database_sizes: JsonDict | None = None

BatchResult

Bases: BatchId

Source code in meilisearch_python_sdk/models/batch.py 
33
34
35
36
37
38
39
class BatchResult(BatchId):
    details: JsonDict | None = None
    progress: JsonDict | None = None
    stats: Stats
    duration: str | None = None
    started_at: datetime | None = None
    finished_at: datetime | None = None

details class-attribute instance-attribute 

details: JsonDict | None = None

progress class-attribute instance-attribute 

progress: JsonDict | None = None

stats instance-attribute 

stats: Stats

duration class-attribute instance-attribute 

duration: str | None = None

started_at class-attribute instance-attribute 

started_at: datetime | None = None

finished_at class-attribute instance-attribute 

finished_at: datetime | None = None

BatchStatus

Bases: CamelBase

Source code in meilisearch_python_sdk/models/batch.py 
42
43
44
45
46
47
class BatchStatus(CamelBase):
    results: list[BatchResult]
    total: int
    limit: int
    from_: int | None = Field(None, alias="from")
    next: int | None = None

results instance-attribute 

results: list[BatchResult]

total instance-attribute 

total: int

limit instance-attribute 

limit: int

from_ class-attribute instance-attribute 

from_: int | None = Field(None, alias='from')

next class-attribute instance-attribute 

next: int | None = None