algoliasearch client python

Der perfekte Ausgangspunkt für die Integration von Algolien in Ihr Python -Projekt

Dokumentation • Django • Community -Forum • Stapelüberlauf • einen Fehler melden • FAQ • Unterstützung

Merkmale

• Dünner und minimaler HTTP-Client auf niedriger Ebene, um mit der API von Algolia zu interagieren
• Unterstützt Python von 3.8

Erste Schritte

Installieren Sie zunächst den Algolia Python API -Client über den PIP -Paket -Manager:

pip install --upgrade ' algoliasearch>=4.0,<5.0 '

Sie können jetzt den Algolia -API -Kunden in Ihr Projekt importieren und damit spielen.

 from algoliasearch . search . client import SearchClient

_client = SearchClient ( "YOUR_APP_ID" , "YOUR_API_KEY" )

# Add a new record to your Algolia index
response = await _client . save_object (
    index_name = "<YOUR_INDEX_NAME>" ,
    body = {
        "objectID" : "id" ,
        "test" : "val" ,
    },
)

# use the class directly
print ( response )

# print the JSON response
print ( response . to_json ())

# Poll the task status to know when it has been indexed
await client . wait_for_task ( index_name = "<YOUR_INDEX_NAME>" , task_id = response . task_id )

# Fetch search results, with typo tolerance
response = await _client . search (
    search_method_params = {
        "requests" : [
            {
                "indexName" : "<YOUR_INDEX_NAME>" ,
                "query" : "<YOUR_QUERY>" ,
                "hitsPerPage" : 50 ,
            },
        ],
    },
)

# use the class directly
print ( response )

# print the JSON response
print ( response . to_json ())

Für die vollständige Dokumentation finden Sie den Algolien -Python -API -Kunden .

❓ Fehlerbehebung

Begegnen ein Problem? Bevor wir uns an die Unterstützung wenden, empfehlen wir, uns zu unseren FAQs zu besuchen, wo Sie Antworten auf die häufigsten Probleme und Gotchas mit dem Kunden finden. Sie können auch ein GitHub -Problem eröffnen

Beitragen

In diesem Repository hostet der Code des generierten Algolien -API -Clients für Python, wenn Sie einen Beitrag leisten möchten, zum Haupt -Repository. Auf unserer Dokumentationswebsite finden Sie auch Anleitungen für die Dokumentation.

? Lizenz

Der Algolia Python API-Client ist eine Open-Sourcing-Software, die unter der MIT-Lizenz lizenziert ist.