Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Strukturierte Entscheidungen einreichen

Felo API Support
MIT
Server:https://openapi.felo.ai
Client-Bibliotheken
Shell Curl

Strukturierte Entscheidungen einreichen

​

Nicht gestreamte Anfrage zu Status und Fragen; Antworten behalten die Decisions-Form.

Header
  • X-Felo-Channel
    Typ: string

    Geordnete, durch Kommas getrennte öffentliche Kanalcodes. Lassen Sie diesen Header weg, um default zu verwenden; default muss allein verwendet werden. Im Wallet-Modus durchsucht default die effektive öffentliche Kanalreihenfolge des Modells in umgekehrter Reihenfolge, überspringt nicht veröffentlichte oder nicht verfügbare Kanäle und wählt den Anbieter des ersten verfügbaren Kanals. Der Wert default schließt verfügbare Endpunkte dieses Anbieters mit derselben Upstream-Modell-ID und demselben Service-Tier ein. Explizite Kanäle werden in der vom Client angegebenen Reihenfolge validiert; nur die Anbietergruppe des ersten Kanals wird übermittelt. Kein automatischer Fallback auf andere Anbieter. Legacy-Anbieter-Header können das Kanal-Routing nicht überschreiben.

Body·DecisionsRequest
erforderlich
application/json

Nicht gestreamte Decisions; Fragedefinitionen werden unverändert durchgereicht.

  • model
    Typ: string
    erforderlich
  • questions
    Typ: object
    erforderlich
    • propertyName
      Typ: object
  • state
    erforderlich
  • service_tier
    Typ: string | null

    Derzeit wird nur default (standard) unterstützt. Weggelassene Werte, null, Aliase und nicht unterstützte Zeichenfolgen fallen auf default zurück; andere Typen liefern HTTP 400. Konfigurierte Kanäle und Preise bleiben unverändert. Text-APIs senden den Standardwert des Anbieters; Decisions- und Generierungs-APIs lassen das Upstream-Feld weg.

  • stream
    Typ: const
    Konstante:  
    false
  • propertyName
    Typ: anything
Antworten
  • 200
    Typ: object · DecisionsResponse

    Entscheidungsantworten

    • answers
      Typ: object
      • propertyName
        Typ: anything
    • id
      Typ: string
    • usage
      Typ: object
      • propertyName
        Typ: anything
    • propertyName
      Typ: anything
    application/json
  • 400
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 401
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 402
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 403
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 429
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 502
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
  • 503
    Typ: object · DecisionsErrorResponse

    Anfrage abgelehnt oder Upstream nicht verfügbar

    • error
      Typ: object
      erforderlich
      • code
        Typ: integer
        erforderlich

        Integer numbers.

      • message
        Typ: string
        erforderlich
    application/json
Request Example for post/api/v1/decisions
curl https://openapi.felo.ai/api/v1/decisions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-decisions-model",
  "state": "A payout failed.",
  "questions": {
    "urgent": {
      "type": "noul",
      "instructions": "Is it urgent?",
      "criteria": {
        "true": "Urgent",
        "false": "No"
      }
    }
  }
}'

{
  "id": "string",
  "answers": {
    "additionalProperty": "anything"
  },
  "usage": {
    "additionalProperty": "anything"
  },
  "additionalProperty": "anything"
}

Entscheidungsantworten

Submit structured decisions