Vektorähnlichkeitsabgleich

Rufen Sie Wissenseinheiten aus der Agenten-/Workflow-Wissensdatenbank basierend auf den bereitgestellten Abfrageinhalten oder Schlüsselwörtern ab. Entwickler:innen können den Suchbereich über group_ids oder data_ids einschränken, den Parameter top_k festlegen und die Recherche durch Wissensrelevanzbewertung und Reranking zur individuellen Anpassung von Retrieval-Augmented Generation (RAG)-Funktionen personalisieren.

Request-Methode

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/vector/match

Authentifizierung

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

Anfrage

Beispielanfrage

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "embedding_rate": 0.9 , "prompt": "Welche APIs bietet GPTBots an?", "group_ids": ["1234567890","1230987654"], "data_ids": ["1234567890","1230987654"], "top_k": 10 , "rerank_version": "Jina-reranker-v2-base-multilingual", "doc_correlation": 0.70 }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json'  \
-d '{
        "embedding_rate": 0.9 ,
        "prompt": "Welche APIs bietet GPTBots an?",
        "group_ids": ["1234567890","1230987654"],
        "data_ids":  ["1234567890","1230987654"],
        "top_k": 10 ,
        "rerank_version": "Jina-reranker-v2-base-multilingual",
        "doc_correlation": 0.70
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Verwenden Sie Authorization: Bearer ${API Key} zur Authentifizierung. Sie erhalten den API-Schlüssel auf der API-Key-Seite.
Content-Type	application/json	Der Wert muss application/json sein.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
embedding_rate	float	Nein	Gibt das Gewichtungsverhältnis zwischen schlüsselwortbasierter und semantischer Recherche an. Wertebereich: [0,1], Standardwert ist 1. Beispiel: 0 = nur Schlüsselwörter; 1 = nur semantisch; 0,4 = 40 % Schlüsselwörter, 60 % semantisch.
prompt	string	Ja	Schlüsselwörter oder Abfrageinhalt, die für den Vektorähnlichkeitsabgleich mit Dokumenten im Agentensystem/Workflow verwendet werden.
group_ids	array	Nein	Wissensdatenbank-IDs für die Vektorrecherche innerhalb bestimmter Wissensdatenbanken. Werden eine oder mehrere IDs angegeben, erfolgt die Recherche in der Vereinigung dieser Wissensdatenbanken. Wenn null oder nicht angegeben, wird standardmäßig in allen Wissensdatenbanken gesucht. Wenn [], wird keine Wissensdatenbank durchsucht.
data_ids	array	Nein	Dokument-IDs für die Vektorrecherche innerhalb bestimmter Wissensdokumente. Werden eine oder mehrere IDs angegeben, erfolgt die Recherche in der Vereinigung dieser Dokumente. Wenn null oder nicht angegeben, wird standardmäßig in allen Wissensdokumenten gesucht. Wenn [], wird kein Wissensdokument durchsucht.
top_k	int	Ja	Nach dem Vektorähnlichkeitsabgleich zwischen Schlüsselwörtern und Dokument-IDs werden die Top-K-Ergebnisse zurückgegeben. Gültiger Bereich: [1,50].
rerank_version	string	Nein	Name des Reranker-Modells für eine präzisere Suche. Optionen: BGE-Rerank, Jina-reranker-v2-base-multilingual, Jina-colbert-v2, BCE-Rerank.
doc_correlation	float	Nein	Wissensrelevanzwert, der die Ähnlichkeit zwischen Nutzeranfrage und Wissenseinheit angibt. Höhere Werte bedeuten größere Relevanz, zu hohe Werte können jedoch dazu führen, dass keine Wissenseinheiten gefunden werden. Bereich: [0,1;0,95].

Wenn sowohl group_ids als auch data_ids angegeben werden, erfolgt die Recherche in der Vereinigung der jeweiligen Wissensbereiche. Wenn beide null oder nicht angegeben sind, werden standardmäßig alle Wissensdatenbanken durchsucht. Wenn beide als leere Arrays ([]) angegeben werden, wird kein Wissen abgerufen.

Antwort

Beispielantwort

{ "total": 2, "list": [ { "content": "Testdaten", "data_id": "aS1CNvPK4XCckDKQNj7azC9a", "document_name": "demo.md", "score": 0.75 }, { "content": "Testdaten", "data_id": "aS1CNvPK4XCckDKQNj7azC9a", "document_name": "demo.md", "score": 0.75 } ] }

                      
                      {
  "total": 2,
  "list": [
    {
      "content": "Testdaten",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "document_name": "demo.md",
      "score": 0.75
    },
    {
      "content": "Testdaten",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "document_name": "demo.md",
      "score": 0.75 
    }
  ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgsantwort

Feld	Typ	Beschreibung
total	int	Gesamtanzahl der zurückgegebenen Einheiten.
list	JSON-Array	Liste der Wissenseinheiten.
content	string	Inhalt der Wissenseinheit.
data_id	string	Quelldokument.
score	float	Ähnlichkeitswert.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Parameterfehler
40127	Entwickler:innen-Authentifizierung fehlgeschlagen
20059	Agent/Workflow gelöscht