meilisearch-python-sdk 3.4.0__py3-none-any.whl → 3.5.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of meilisearch-python-sdk might be problematic. Click here for more details.

@@ -35,7 +35,6 @@ async def async_cancel_tasks(
35
35
  Defaults to cancelling all tasks.
36
36
 
37
37
  Args:
38
-
39
38
  client: An httpx HttpxAsyncClient or meilisearch_python_sdk AsyncClient instance.
40
39
  uids: A list of task UIDs to cancel.
41
40
  index_uids: A list of index UIDs for which to cancel tasks.
@@ -47,17 +46,14 @@ async def async_cancel_tasks(
47
46
  after_finished_at: Cancel tasks that were finished after the specified date time.
48
47
 
49
48
  Returns:
50
-
51
49
  The details of the task
52
50
 
53
51
  Raises:
54
-
55
52
  MeilisearchCommunicationError: If there was an error communicating with the server.
56
53
  MeilisearchApiError: If the Meilisearch API returned an error.
57
54
  MeilisearchTimeoutError: If the connection times out.
58
55
 
59
- Examples:
60
-
56
+ Examples
61
57
  >>> from meilisearch_python_sdk import AsyncClient
62
58
  >>> from meilisearch_python_sdk.task import cancel_tasks
63
59
  >>>
@@ -1 +1 @@
1
- VERSION = "3.4.0"
1
+ VERSION = "3.5.1"
@@ -33,7 +33,6 @@ def async_add_documents(
33
33
  It is required that either an async_client or url is provided.
34
34
 
35
35
  Args:
36
-
37
36
  index_name: The name of the index to which the documents should be added.
38
37
  connection_info: Either an AsyncClient instance ConnectionInfo with informtaion on how to
39
38
  connect to Meilisearch.
@@ -46,17 +45,14 @@ def async_add_documents(
46
45
  verify: If set to `False` the decorator will not verify the SSL certificate of the server.
47
46
 
48
47
  Returns:
49
-
50
48
  The list of documents proviced by the decorated function.
51
49
 
52
50
  Raises:
53
-
54
51
  MeilisearchCommunicationError: If there was an error communicating with the server.
55
52
  MeilisearchApiError: If the Meilisearch API returned an error.
56
53
  ValueError: If neither an async_client nor an url is provided.
57
54
 
58
- Examples:
59
-
55
+ Examples
60
56
  >>> from meilisearch_python_sdk import AsyncClient
61
57
  >>> from meilisearch_python_sdk.decorators import async_add_documents, ConnectionInfo
62
58
  >>>
@@ -119,7 +115,6 @@ def add_documents(
119
115
  It is required that either an client or url is provided.
120
116
 
121
117
  Args:
122
-
123
118
  index_name: The name of the index to which the documents should be added.
124
119
  connection_info: Either an Client instance ConnectionInfo with informtaion on how to
125
120
  connect to Meilisearch.
@@ -132,17 +127,14 @@ def add_documents(
132
127
  verify: If set to `False` the decorator will not verify the SSL certificate of the server.
133
128
 
134
129
  Returns:
135
-
136
130
  The list of documents proviced by the decorated function.
137
131
 
138
132
  Raises:
139
-
140
133
  MeilisearchCommunicationError: If there was an error communicating with the server.
141
134
  MeilisearchApiError: If the Meilisearch API returned an error.
142
135
  ValueError: If neither an async_client nor an url is provided.
143
136
 
144
- Examples:
145
-
137
+ Examples
146
138
  >>> from meilisearch_python_sdk import Client
147
139
  >>> from meilisearch_python_sdk.decorators import add_documents, ConnectionInfo
148
140
  >>>