Client
client
Usage
Create a client
To create a client:
from milisearch_python_sdk import Client
client = Client("http://localhost:7700", "masterKey")
index = client.index("movies")
...
Custom headers
Custom headers can be added to the client by adding them to custom_headers
when creating the
client.
from meilisearch_python_sdk import Client
client = Client(
"http://127.0.0.1:7700",
"masterKey",
custom_headers={"header_key_1": "header_value_1", "header_key_2": "header_value_2"}
)
index = client.index("movies")
...
Client
API
Bases: BaseClient
client to connect to the Meilisearch API.
Source code in meilisearch_python_sdk/_client.py
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 |
|
__init__(url, api_key=None, *, timeout=None, verify=True, custom_headers=None, json_handler=None, http2=False)
Class initializer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
The url to the Meilisearch API (ex: http://localhost:7700) |
required |
api_key
|
str | None
|
The optional API key for Meilisearch. Defaults to None. |
None
|
timeout
|
int | None
|
The amount of time in seconds that the client will wait for a response before timing out. Defaults to None. |
None
|
verify
|
bool | SSLContext
|
SSL certificates (a.k.a CA bundle) used to
verify the identity of requested hosts. Either |
True
|
custom_headers
|
dict[str, str] | None
|
Custom headers to add when sending data to Meilisearch. Defaults to None. |
None
|
json_handler
|
BuiltinHandler | OrjsonHandler | UjsonHandler | None
|
The module to use for json operations. The options are BuiltinHandler (uses the json module from the standard library), OrjsonHandler (uses orjson), or UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding extra needs to be included. Default: BuiltinHandler. |
None
|
http2
|
bool
|
If set to True, the client will use HTTP/2. Defaults to False. |
False
|
Source code in meilisearch_python_sdk/_client.py
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 |
|
add_or_update_networks(*, network)
Set or update remote networks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
network
|
Network
|
Information to use for the networks. |
required |
Returns:
Type | Description |
---|---|
Network
|
An instance of Network containing the network information. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> from meilisearch_python_sdk.models.client import Network, Remote
>>>
>>>
>>> network = Network(
>>> self_="remote_1",
>>> remotes={
>>> "remote_1": {"url": "http://localhost:7700", "searchApiKey": "xxxx"},
>>> "remote_2": {"url": "http://localhost:7720", "searchApiKey": "xxxx"},
>>> },
>>> )
>>> client = Client("http://localhost.com", "masterKey")
>>> response = client.add_or_update_networks(network=network)
Source code in meilisearch_python_sdk/_client.py
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 |
|
cancel_tasks(*, uids=None, index_uids=None, statuses=None, types=None, before_enqueued_at=None, after_enqueued_at=None, before_started_at=None, after_finished_at=None)
Cancel a list of enqueued or processing tasks.
Defaults to cancelling all tasks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uids
|
list[int] | None
|
A list of task UIDs to cancel. |
None
|
index_uids
|
list[int] | None
|
A list of index UIDs for which to cancel tasks. |
None
|
statuses
|
list[str] | None
|
A list of statuses to cancel. |
None
|
types
|
list[str] | None
|
A list of types to cancel. |
None
|
before_enqueued_at
|
datetime | None
|
Cancel tasks that were enqueued before the specified date time. |
None
|
after_enqueued_at
|
datetime | None
|
Cancel tasks that were enqueued after the specified date time. |
None
|
before_started_at
|
datetime | None
|
Cancel tasks that were started before the specified date time. |
None
|
after_finished_at
|
datetime | None
|
Cancel tasks that were finished after the specified date time. |
None
|
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk.task import cancel_tasks >>> >>> client = Client("http://localhost.com", "masterKey") >>> client.cancel_tasks(uids=[1, 2])
Source code in meilisearch_python_sdk/_client.py
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 |
|
create_dump()
Trigger the creation of a Meilisearch dump.
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> client.create_dump()
Source code in meilisearch_python_sdk/_client.py
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 |
|
create_index(uid, primary_key=None, *, settings=None, wait=True, timeout_in_ms=None, plugins=None, hits_type=JsonDict)
Creates a new index.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
primary_key
|
str | None
|
The primary key of the documents. Defaults to None. |
None
|
settings
|
MeilisearchSettings | None
|
Settings for the index. The settings can also be updated independently of creating the index. The advantage to updating them here is updating the settings after adding documents will cause the documents to be re-indexed. Because of this it will be faster to update them before adding documents. Defaults to None (i.e. default Meilisearch index settings). |
None
|
wait
|
bool
|
If set to True and settings are being updated, the index will be returned after the settings update has completed. If False it will not wait for settings to complete. Default: True |
True
|
timeout_in_ms
|
int | None
|
Amount of time in milliseconds to wait before raising a
MeilisearchTimeoutError. |
None
|
plugins
|
IndexPlugins | None
|
Optional plugins can be provided to extend functionality. |
None
|
hits_type
|
Any
|
Allows for a custom type to be passed to use for hits. Defaults to JsonDict |
JsonDict
|
Returns:
Type | Description |
---|---|
Index
|
An instance of Index containing the information of the newly created index. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.create_index("movies")
Source code in meilisearch_python_sdk/_client.py
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 |
|
create_key(key)
Creates a new API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
KeyCreate
|
The information to use in creating the key. Note that if an expires_at value is included it should be in UTC time. |
required |
Returns:
Type | Description |
---|---|
Key
|
The new API key. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> from meilissearch_async_client.models.client import KeyCreate >>> client = Client("http://localhost.com", "masterKey") >>> key_info = KeyCreate( >>> description="My new key", >>> actions=["search"], >>> indexes=["movies"], >>> ) >>> keys = client.create_key(key_info)
Source code in meilisearch_python_sdk/_client.py
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 |
|
create_snapshot()
Trigger the creation of a Meilisearch snapshot.
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> client.create_snapshot()
Source code in meilisearch_python_sdk/_client.py
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 |
|
create_webhook(webhook)
Create a new webhook.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
webhook
|
WebhookCreate
|
The webhook configuration to create. |
required |
Returns:
Type | Description |
---|---|
Webhook
|
The created webhook. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> from meilisearch_python_sdk.models.webhook import WebhookCreate
>>> client = Client("http://localhost.com", "masterKey")
>>> webhook_config = WebhookCreate(
>>> url="https://example.com/webhook",
>>> headers={"Authorization": "Bearer token"}
>>> )
>>> webhook = client.create_webhook(webhook_config)
Source code in meilisearch_python_sdk/_client.py
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 |
|
delete_index_if_exists(uid)
Deletes an index if it already exists.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
Returns:
Type | Description |
---|---|
bool
|
True if an index was deleted for False if not. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> client.delete_index_if_exists()
Source code in meilisearch_python_sdk/_client.py
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
|
delete_key(key)
Deletes an API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The key or uid to delete. |
required |
Returns:
Type | Description |
---|---|
int
|
The Response status code. 204 signifies a successful delete. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> client.delete_key("abc123")
Source code in meilisearch_python_sdk/_client.py
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 |
|
delete_tasks(*, uids=None, index_uids=None, statuses=None, types=None, before_enqueued_at=None, after_enqueued_at=None, before_started_at=None, after_finished_at=None)
Delete a list of tasks.
Defaults to deleting all tasks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uids
|
list[int] | None
|
A list of task UIDs to delete. |
None
|
index_uids
|
list[int] | None
|
A list of index UIDs for which to delete tasks. |
None
|
statuses
|
list[str] | None
|
A list of statuses to delete. |
None
|
types
|
list[str] | None
|
A list of types to delete. |
None
|
before_enqueued_at
|
datetime | None
|
Delete tasks that were enqueued before the specified date time. |
None
|
after_enqueued_at
|
datetime | None
|
Delete tasks that were enqueued after the specified date time. |
None
|
before_started_at
|
datetime | None
|
Delete tasks that were started before the specified date time. |
None
|
after_finished_at
|
datetime | None
|
Delete tasks that were finished after the specified date time. |
None
|
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> >>> client = Client("http://localhost.com", "masterKey") >>> client.delete_tasks(client, uids=[1, 2])
Source code in meilisearch_python_sdk/_client.py
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 |
|
delete_webhook(uuid)
Delete a webhook.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uuid
|
str
|
The webhook's unique identifier. |
required |
Returns:
Type | Description |
---|---|
int
|
The Response status code. 204 signifies a successful delete. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> client = Client("http://localhost.com", "masterKey")
>>> client.delete_webhook("abc-123")
Source code in meilisearch_python_sdk/_client.py
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 |
|
get_all_stats()
Get stats for all indexes.
Returns:
Name | Type | Description |
---|---|---|
ClientStats
|
Information about database size and all indexes. |
|
https |
ClientStats
|
//docs.meilisearch.com/reference/api/stats.html |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> stats = client.get_all_stats()
Source code in meilisearch_python_sdk/_client.py
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 |
|
get_index(uid)
Gets a single index based on the uid of the index.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
Returns:
Type | Description |
---|---|
Index
|
An Index instance containing the information of the fetched index. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.get_index()
Source code in meilisearch_python_sdk/_client.py
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 |
|
get_indexes(*, offset=None, limit=None)
Get all indexes. Args: offset: Number of indexes to skip. The default of None will use the Meilisearch default. limit: Number of indexes to return. The default of None will use the Meilisearch default.
Returns:
Type | Description |
---|---|
list[Index] | None
|
A list of all indexes. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") as client: >>> indexes = client.get_indexes()
Source code in meilisearch_python_sdk/_client.py
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
|
get_key(key)
Gets information about a specific API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The key for which to retrieve the information. |
required |
Returns:
Type | Description |
---|---|
Key
|
The API key, or |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> keys = client.get_key("abc123")
Source code in meilisearch_python_sdk/_client.py
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 |
|
get_keys(*, offset=None, limit=None)
Gets the Meilisearch API keys. Args: offset: Number of indexes to skip. The default of None will use the Meilisearch default. limit: Number of indexes to return. The default of None will use the Meilisearch default.
Returns:
Type | Description |
---|---|
KeySearch
|
API keys. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = AsyncClient("http://localhost.com", "masterKey") >>> keys = client.get_keys()
Source code in meilisearch_python_sdk/_client.py
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 |
|
get_networks()
Fetches the remote-networks
Returns:
Type | Description |
---|---|
Network
|
An instance of Network containing information about each remote. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import AsyncClient
>>>
>>>
>>> client = Client("http://localhost.com", "masterKey")
>>> response = client.get_networks()
Source code in meilisearch_python_sdk/_client.py
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 |
|
get_or_create_index(uid, primary_key=None, *, plugins=None, hits_type=JsonDict)
Get an index, or create it if it doesn't exist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
primary_key
|
str | None
|
The primary key of the documents. Defaults to None. |
None
|
plugins
|
IndexPlugins | None
|
Optional plugins can be provided to extend functionality. |
None
|
hits_type
|
Any
|
Allows for a custom type to be passed to use for hits. Defaults to JsonDict |
JsonDict
|
Returns:
Type | Description |
---|---|
Index
|
An instance of Index containing the information of the retrieved or newly created index. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error.MeilisearchTimeoutError: If the connection times out. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.get_or_create_index("movies")
Source code in meilisearch_python_sdk/_client.py
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
|
get_raw_index(uid)
Gets the index and returns all the index information rather than an Index instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
Returns:
Type | Description |
---|---|
IndexInfo | None
|
Index information rather than an Index instance. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.get_raw_index("movies")
Source code in meilisearch_python_sdk/_client.py
1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 |
|
get_raw_indexes(*, offset=None, limit=None)
Gets all the indexes. Args: offset: Number of indexes to skip. The default of None will use the Meilisearch default. limit: Number of indexes to return. The default of None will use the Meilisearch default.
Returns all the index information rather than an AsyncIndex instance.
Returns:
Type | Description |
---|---|
list[IndexInfo] | None
|
A list of the Index information rather than an AsyncIndex instances. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.get_raw_indexes()
Source code in meilisearch_python_sdk/_client.py
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 |
|
get_task(task_id)
Get a single task from it's task id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
task_id
|
int
|
Identifier of the task to retrieve. |
required |
Returns:
Type | Description |
---|---|
TaskResult
|
Results of a task. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> >>> client = AsyncClient("http://localhost.com", "masterKey") >>> get_task(client, 1244)
Source code in meilisearch_python_sdk/_client.py
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 |
|
get_tasks(*, index_ids=None, types=None, reverse=None)
Get multiple tasks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index_ids
|
list[str] | None
|
A list of index UIDs for which to get the tasks. If provided this will get the tasks only for the specified indexes, if not all tasks will be returned. Default = None |
None
|
types
|
str | list[str] | None
|
Specify specific task types to retrieve. Default = None |
None
|
reverse
|
bool | None
|
If True the tasks will be returned in reverse order. Default = None |
None
|
Returns:
Type | Description |
---|---|
TaskStatus
|
Task statuses. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> >>> client = Client("http://localhost.com", "masterKey") >>> client.get_tasks(client)
Source code in meilisearch_python_sdk/_client.py
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 |
|
get_version()
Get the Meilisearch version.
Returns:
Type | Description |
---|---|
Version
|
Information about the version of Meilisearch. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> version = client.get_version()
Source code in meilisearch_python_sdk/_client.py
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 |
|
get_webhook(uuid)
Get a specific webhook by UUID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uuid
|
str
|
The webhook's unique identifier. |
required |
Returns:
Type | Description |
---|---|
Webhook
|
An instance of Webhook containing the webhook information. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> client = Client("http://localhost.com", "masterKey")
>>> webhook = client.get_webhook("abc-123")
Source code in meilisearch_python_sdk/_client.py
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
|
get_webhooks()
Get all webhooks.
Returns:
Type | Description |
---|---|
Webhooks
|
An instance of Webhooks containing all configured webhooks. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> client = Client("http://localhost.com", "masterKey")
>>> webhooks = client.get_webhooks()
Source code in meilisearch_python_sdk/_client.py
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 |
|
health()
Get health of the Meilisearch server.
Returns:
Type | Description |
---|---|
Health
|
The status of the Meilisearch server. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> health = client.get_health()
Source code in meilisearch_python_sdk/_client.py
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 |
|
index(uid, *, plugins=None)
Create a local reference to an index identified by UID, without making an HTTP call.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uid
|
str
|
The index's unique identifier. |
required |
plugins
|
IndexPlugins | None
|
Optional plugins can be provided to extend functionality. |
None
|
Returns:
Type | Description |
---|---|
Index
|
An Index instance. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies")
Source code in meilisearch_python_sdk/_client.py
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 |
|
multi_search(queries, *, federation=None, hits_type=JsonDict)
Multi-index search.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
queries
|
list[SearchParams]
|
List of SearchParameters |
required |
federation
|
Federation | FederationMerged | None
|
If included a single search result with hits built from all queries will be returned. This parameter can only be used with Meilisearch >= v1.10.0. Defaults to None. |
None
|
hits_type
|
Any
|
Allows for a custom type to be passed to use for hits. Defaults to JsonDict |
JsonDict
|
Returns:
Type | Description |
---|---|
list[SearchResultsWithUID] | SearchResultsFederated
|
Results of the search |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk.models.search import SearchParams >>> client = Client("http://localhost.com", "masterKey") >>> queries = [ >>> SearchParams(index_uid="my_first_index", query"Some search"), >>> SearchParams(index_uid="my_second_index", query="Another search") >>> ] >>> search_results = client.search(queries)
Source code in meilisearch_python_sdk/_client.py
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 |
|
swap_indexes(indexes, rename=False)
Swap two indexes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
indexes
|
list[tuple[str, str]]
|
A list of tuples, each tuple should contain the indexes to swap. |
required |
rename
|
bool
|
Use rename false if you are swapping two existing indexes. Use rename true if the second index in your array does not exist. Default = False |
False
|
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.swap_indexes([("index_a", "index_b")])
Source code in meilisearch_python_sdk/_client.py
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 |
|
transfer_documents(url, *, api_key=None, payload_size=None, indexes=None)
Transfer settings and documents from one Meilisearch instance to another.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
Where to send our settings and documents. |
required |
api_key
|
str | None
|
The API key with the rights to send the requests. Usually the master key of the remote machine. Defaults to None. |
None
|
payload_size
|
str | None
|
Human readable size defining the size of the payloads to send. Defaults to 50 MiB. |
None
|
indexes
|
JsonMapping | None
|
A set of patterns of matching the indexes you want to export. Defaults to all indexes without filter. |
None
|
Returns:
Type | Description |
---|---|
TaskInfo
|
The details of the task. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index.transfer_documents("https://another-instance.com", api_key="otherMasterKey")
Source code in meilisearch_python_sdk/_client.py
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 |
|
update_key(key)
Update an API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
KeyUpdate
|
The information to use in updating the key. Note that if an expires_at value is included it should be in UTC time. |
required |
Returns:
Type | Description |
---|---|
Key
|
The updated API key. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples >>> from meilisearch_python_sdk import Client >>> from meilissearch_async_client.models.client import KeyUpdate >>> client = Client("http://localhost.com", "masterKey") >>> key_info = KeyUpdate( key="abc123", >>> indexes=["*"], >>> ) >>> keys = client.update_key(key_info)
Source code in meilisearch_python_sdk/_client.py
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 |
|
update_webhook(*, uuid, webhook)
Update an existing webhook.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
uuid
|
str
|
The webhook's unique identifier. |
required |
webhook
|
WebhookUpdate
|
The webhook configuration updates. |
required |
Returns:
Type | Description |
---|---|
Webhook
|
The updated webhook. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
Examples:
>>> from meilisearch_python_sdk import Client
>>> from meilisearch_python_sdk.models.webhook import WebhookUpdate
>>> client = Client("http://localhost.com", "masterKey")
>>> webhook_update = WebhookUpdate(url="https://example.com/new-webhook")
>>> webhook = client.update_webhook("abc-123", webhook_update)
Source code in meilisearch_python_sdk/_client.py
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 |
|
wait_for_task(task_id, *, timeout_in_ms=5000, interval_in_ms=50, raise_for_status=False)
Wait until Meilisearch processes a task, and get its status.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
task_id
|
int
|
Identifier of the task to retrieve. |
required |
timeout_in_ms
|
int | None
|
Amount of time in milliseconds to wait before raising a
MeilisearchTimeoutError. |
5000
|
interval_in_ms
|
int
|
Time interval in miliseconds to sleep between requests. Defaults to 50. |
50
|
raise_for_status
|
bool
|
When set to |
False
|
Returns:
Type | Description |
---|---|
TaskResult
|
Details of the processed update status. |
Raises:
Type | Description |
---|---|
MeilisearchCommunicationError
|
If there was an error communicating with the server. |
MeilisearchApiError
|
If the Meilisearch API returned an error. |
MeilisearchTimeoutError
|
If the connection times out. |
MeilisearchTaskFailedError
|
If |
Examples >>> from meilisearch_python_sdk import Client >>> documents = [ >>> {"id": 1, "title": "Movie 1", "genre": "comedy"}, >>> {"id": 2, "title": "Movie 2", "genre": "drama"}, >>> ] >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> response = await index.add_documents(documents) >>> client.wait_for_task(response.update_id)
Source code in meilisearch_python_sdk/_client.py
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 |
|