Nachricht senden

Senden Sie eine Nachricht an die angegebene Konversations-ID und erhalten Sie die Antwortnachricht des Agenten. Es ist möglich, Text und/oder Bilder als Nachrichteninhalt zu übermitteln.

Anfragemethode

POST

Anfrage-URL

https://api-${endpoint}.gptbots.ai/v1/conversation/message

Authentifizierung der Anfrage

Siehe Übersicht für Details zur Authentifizierung.

Anfrage

Beispielanfrage

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/message' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "text": "HI！", "conversation_id": "xxxxxx", "response_mode": "streaming", "short_term_memory": true, "long_term_memory": false, "files":[ { "url": "https://res.srcgptbots.com/ailab/botchat/file/38f13465ad5246190b759b3289ecba51.jpg", "name": "something.jpg", "width": 200, "height": 200 }, { "base64_content": "Your_file_base64_content", "name": "something.pdf" } ], "knowledge": { "data_ids": [ "48c70da0403cc812641b934f", "48c70da0403cc812641df35k" ] } }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/message' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
      "text": "HI！",
      "conversation_id": "xxxxxx",
      "response_mode": "streaming",
      "short_term_memory": true,
      "long_term_memory": false,
      "files":[
          {
            "url": "https://res.srcgptbots.com/ailab/botchat/file/38f13465ad5246190b759b3289ecba51.jpg",
            "name": "something.jpg",
            "width": 200,
            "height": 200
          },
          {
            "base64_content": "Your_file_base64_content", 
            "name": "something.pdf"
          }
      ],
      "knowledge": {
        "data_ids": [
          "48c70da0403cc812641b934f",
          "48c70da0403cc812641df35k"
        ]
      }
}'

Dieser Codeblock im schwebenden Fenster

Feld	Typ	Beschreibung
Authorization	Bearer ${token}	Verwenden Sie Authorization: Bearer ${token} zur Authentifizierung. Den Schlüssel erhalten Sie auf der API-Key-Seite als Token.
Content-Type	application/json	Datentyp, auf application/json setzen.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
text	string	Ja	Entweder Text oder Dateien müssen angegeben werden. Die Textnachricht des Nutzers. Die Länge des Textinhalts darf das in der Agent-Konfiguration festgelegte Token-Limit nicht überschreiten.
files	JSON Array	Nein	Text und Dateien müssen mindestens einen Wert enthalten. Dateien dienen dazu, Bilder, Audio- und Dokumentdaten an den Agenten zu übermitteln. Der Agent unterstützt zwei Dateierkennungsmodi: „System-Dateierkennung“ und „LLM-Dateierkennung“. Verschiedene Erkennungsmodi unterstützen unterschiedliche Dateitypen. Netzwerkpfade für die Dateieinreichung werden unterstützt, maximal 9 Dateien können hochgeladen werden. Dokumente ≤20 MB, Bilder ≤10 MB, Audio ≤5 MB. LLM-Dateierkennung Die unterstützten Dateitypen hängen von den Fähigkeiten des jeweiligen LLM ab. Bei einem Flow-Agenten wird die Schnittmenge aller von den LLMs unterstützten Dateitypen verwendet. System-Dateierkennung Das GPTBots-System erkennt hochgeladene Dateien und wandelt sie in Text um. Dokumenttypen: .pdf, .txt, .docx, .csv, .xlsx, .html, .c, .cpp, .java, .json, .md, .php, .pptx, .py, .rb, .tex, .css, .js, .ts, .xml Bildtypen: .jpg, .jpeg, .png, .gif, .webp Audiotypen: .mp3, .wav, .acc Dateiübermittlungsspezifikationen base64_content, string, Dateistream (alternativ zur Datei-URL) url, string, Datei-URL (alternativ zum Dateistream) name, string, Dateiname width, int, Bildbreite (erforderlich bei Bildtypen) height, int, Bildhöhe (erforderlich bei Bildtypen)
conversation_id	string	Ja	Konversations-ID, wird benötigt, um eine bestehende Konversation fortzusetzen.
response_mode	string	Ja	blocking: Blocking: Warten, bis die Antwort vollständig ist, bevor das Ergebnis zurückgegeben wird. (Lange Anfragen können unterbrochen werden) streaming: Streaming-Antwort, basierend auf SSE (Server-Sent Events). webhook: Nachrichten vom Agenten und vom menschlichen Kundendienst werden an die auf der API-Seite konfigurierte Webhook-Adresse gesendet.
short_term_memory	boolean	Nein	Wird bei dieser Nachricht der Kurzzeitspeicher innerhalb der Konversation als Kontext verwendet? Wenn nicht ausgefüllt, gelten die Speichereinstellungen des Agenten.
long_term_memory	boolean	Nein	Wird bei dieser Nachricht der Langzeitspeicher innerhalb der Konversation als Kontext verwendet? Wenn nicht ausgefüllt, gelten die Speichereinstellungen des Agenten.
knowledge	object	Nein	Individuelle Anpassung des Wissensabrufs für diese Nachricht. Fehlt dieses Feld, wird die Standard-Wissenskonfiguration des Agenten zur Suche verwendet.
data_ids	array	Nein	`data_ids` ist ein Array von Wissensdokument-IDs. Wenn dieser Parameter ein leeres Array ist, z. B. `"data_ids": []`, werden keine Wissensdokumente abgerufen. Wenn Werte vorhanden sind, ist der Abruf auf die angegebenen Wissensdokument-IDs beschränkt.

Antwort

Beispielantwort

{ "message_id": "65a4ccfC7ce58e728d5897e0", "message_type": "ANSWER", "text": "Hi, kann ich Ihnen irgendwie helfen?", "flow_output": [ { "content": "Hallo", "branch": "1", "from_component_name": "User Input" } ], "create_time": 1679587005, "conversation_id": "657303a8a764d47094874bbe" }

                      
                      {
  "message_id": "65a4ccfC7ce58e728d5897e0",
  "message_type": "ANSWER",
  "text": "Hi, kann ich Ihnen irgendwie helfen?",
  "flow_output": [
    {
      "content": "Hallo",
      "branch": "1", 
      "from_component_name": "User Input"
    }
  ],
  "create_time": 1679587005,
  "conversation_id": "657303a8a764d47094874bbe"
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort (Blocking)

Feld	Typ	Beschreibung
message_id	string	Eindeutige Nachrichten-ID.
message_type	string	Nachrichtentyp, Werte: ANSWER, QUESTION.
text	string	Antworttext.
flow_output	JSON Array	Antwortinhalt des Flow-Agenten.
content	string	Antworttext der Flow-Agenten-Komponente.
branch	string	Flow-Agenten-Branch.
from_component_name	string	Name der vorgelagerten Flow-Agenten-Komponente.
create_time	long	Zeitstempel der Antwortnachricht.
conversation_id	string	Konversations-ID.

Erfolgreiche Antwort (Streaming)

Feld	Typ	Beschreibung
code	int	Nachrichtentyp-Code, 3-Text, 10-FlowOutput, 0-Ende.
message	string	Nachrichtentyp, Werte: Text, FlowOutput, End.
data	object	Antwortinhalt.

Streaming-Daten werden in mehreren Teilen zurückgegeben:

{"code":11,"message":"MessageInfo","data":{"message_id":"6785dba0f06d872bff9ee347"}} {"code":3,"message":"Text","data":"I"} {"code":3,"message":"Text","data":"can"} {"code":3,"message":"Text","data":"help"} {"code":3,"message":"Text","data":"you"} {"code":3,"message":"Text","data":"?"} {"code":10,"message":"FlowOutput","data":[{"content":"Hallo","branch":null,"from_component_name":"User Input"}]} {"code":0,"message":"Ende","data":null}

                      
                      {"code":11,"message":"MessageInfo","data":{"message_id":"6785dba0f06d872bff9ee347"}}
{"code":3,"message":"Text","data":"I"}
{"code":3,"message":"Text","data":"can"}  
{"code":3,"message":"Text","data":"help"}
{"code":3,"message":"Text","data":"you"}
{"code":3,"message":"Text","data":"?"}
{"code":10,"message":"FlowOutput","data":[{"content":"Hallo","branch":null,"from_component_name":"User Input"}]}
{"code":0,"message":"Ende","data":null}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort (Webhook)

Wenn die Entwickler:innen eine Webhook-Adresse konfiguriert haben, sendet das GPTBots-System bei erfolgreicher Antwort Nachrichten sowohl vom Agenten als auch vom menschlichen Kundendienst an die Webhook-Adresse. Für das detaillierte Nachrichtenformat siehe Webhook-Modus.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Ungültiger Parameter
40127	Entwicklerauthentifizierung fehlgeschlagen
40356	Konversation existiert nicht
50000	Interner Serverfehler
40364	Dieser Agent verwendet kein LLM, das den Bildmodus unterstützt
20059	Agent gelöscht
20040	Frage-Limit überschritten
40358	conversation_id stimmt nicht mit Agent oder Nutzer:in überein
20022	Guthaben nicht ausreichend