Dokumentmetadatenwert aktualisieren

Aktualisieren Sie die Metadatenwerte der angegebenen Dokumente. Dokumente werden anhand ihrer ID und Felder anhand ihres Namens identifiziert. Die Aktualisierung erfolgt als inkrementelle Zusammenführung: Nur übergebene Felder werden geändert, alle anderen bleiben unverändert. Eine leere Zeichenfolge `""` löscht den Wert des jeweiligen Feldes. Pro Anfrage können bis zu 50 Dokumente aktualisiert werden.

Anfragemethode

PUT

Endpunkt

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/update

Authentifizierung

Informationen zur Authentifizierung finden Sie in der API-Übersicht.

Anfrage

Anfragebeispiel

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "documents": [ { "doc_id": "doc_001", "metadata": { "category": "Technik", "priority": "P1" } }, { "doc_id": "doc_002", "metadata": { "category": "Produkt", "priority": "" } } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "documents": [
        {
            "doc_id": "doc_001",
            "metadata": { "category": "Technik", "priority": "P1" }
        },
        {
            "doc_id": "doc_002",
            "metadata": { "category": "Produkt", "priority": "" }
        }
    ]
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Authentifizieren Sie sich mit `Authorization: Bearer ${API Key}`. Den API Key erhalten Sie auf der API-Schlüsselseite.
Content-Type	application/json	Datentyp, eingestellt auf `application/json`.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
documents	Array<Object>	Ja	Eine Liste der zu aktualisierenden Dokumente, bis zu 50 gleichzeitig.
doc_id	String	Ja	Dokument-ID.
metadata	Object	Nein	„Feldname → Wert“. Eine leere Zeichenfolge löscht den Feldwert und nicht übertragene Felder bleiben unverändert. Der Feldname muss ein definiertes Feld im Rahmen des Dokuments sein.

Hinweis: Ein Feld vom Typ LIST akzeptiert nur Werte, die in seinen options definiert sind. Andernfalls schlägt der Dokumenteintrag mit field 'x' contains value not in options fehl. In derselben Anfrage wird derselbe Metadatenschlüssel unter derselben doc_id nur beim ersten Vorkommen aktualisiert. Jeder nachfolgende Dokumenteintrag mit diesem doppelten Schlüssel schlägt vollständig mit duplicate metadata key 'x' for doc_id 'y'; only the first value is applied fehl. Die doc_id muss zum Agent gehören, der dem aktuellen API Key zugeordnet ist; andernfalls wird doc not found zurückgegeben.

Antwort

Antwortbeispiel

{ "success_count": 1, "failure_count": 2, "results": [ { "doc_id": "doc_001", "success": true }, { "doc_id": "doc_002", "success": false, "error_message": "field 'priority2' is not defined" }, { "doc_id": "doc_003", "success": false, "error_message": "doc not found" } ] }

                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "doc_id": "doc_001",
            "success": true
        },
        {
            "doc_id": "doc_002",
            "success": false,
            "error_message": "field 'priority2' is not defined"
        },
        {
            "doc_id": "doc_003",
            "success": false,
            "error_message": "doc not found"
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
success_count	Integer	Anzahl der Dokumente, die erfolgreich aktualisiert wurden.
failure_count	Integer	Anzahl der Dokumente, deren Aktualisierung fehlgeschlagen ist.
results	Array<Object>	Dokumentweise Ergebnisse.
doc_id	String	Dokument-ID.
success	Boolean	Gibt an, ob die Aktualisierung erfolgreich war.
error_message	String	Fehlergrund, zum Beispiel: `doc not found` (Dokument existiert nicht oder gehört nicht zum aktuellen Agent), `field 'x' is not defined` (Feldname ist nicht definiert), `field 'x' contains value not in options` (LIST-Wert ist keine zulässige Option) oder `duplicate metadata key 'x' for doc_id 'y'; only the first value is applied` (doppeltes Feld in der Anfrage; der erste Wert wird angewendet).

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.