Formular-API

Warning

Diese API befindet sich in der Alpha-Vorschau und kann in Zukunft geändert oder entfernt werden.

Die schrittweise Anzeige von Formularfeldern und die Validierung von Formulardaten werden von unserer Formular-Interaktions-API unterstützt.

Der Transport-Demo-Agent veranschaulicht die Verwendung dieser Funktion; klicken Sie bitte auf den Reiter Code, um den YAML-Code dieses Agenten anzuzeigen, und beachten Sie das in output.schema.properties eingebettete JSON Schema.

Erstellen Sie einen API-Schlüssel, um die Formular-_Vorschau_-API zu nutzen, z. B. mit curl:

curl --no-progress-meter -X 'POST' 'https://api.aish.li/v1/form?agent=demo%2Ftransport' \
  -H 'X-API-Key: sk_...' \
  | jq .

gibt zurück:

{
  "sessionID": "uXxvDmOLaYkGU0qIMpd359Q",
  "mapForm": {
    "nextQuestion": "Do you need a ride? Just let me know your origin, destination, day and time you're interested in!\n",
    "isFormComplete": false
  }
}

Sie können dann die zurückgegebene sessionID verwenden, um die Benutzereingabe zu übermitteln und verbleibende Felder schrittweise zu validieren oder offenzulegen, z. B.:

curl --no-progress-meter -X 'POST' \
  'https://api.aish.li/v1/form/uXxvDmOLaYkGU0qIMpd359Q?agent=demo%2Ftransport' \
  -H 'X-API-Key: sk_...' \
  -d 'John Doe, von Novello nach Barolo' \
  | jq .

was Folgendes zurückgibt:

{
  "sessionID": "uXxvDmOLaYkGU0qIMpd359Q",
  "mapForm": {
    "data": {
      "origin_longitude": 7.9258,
      "origin_date_time": "2026-09-26T15:09Z",
      "destination_latitude": 44.6104,
      "origin": "Novello",
      "name": "John Doe",
      "destination": "Barolo",
      "destination_longitude": 7.9414,
      "origin_latitude": 44.5894
    },
    "isFormComplete": true
  }
}