Predictive Intelligence-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Die Predictive Intelligence Die API stellt Endpunkte bereit, die einen Feldwert basierend auf einem oder mehreren Eingabefeldern und einer trainierten Lösung vorhersagen.

    Sie können diese API nur verwenden, wenn Predictive Intelligence(com.glide.platform_ml) Plugin ist aktiviert.

    Predictive Intelligence – GET /Agent_Intelligence/Solution/{Solution_Name}/Prediction

    Prognostiziert einen Ausgabefeldwert mithilfe einer bestimmten Lösung.

    URL-Format

    Standard-URL: /api/now/Agent_Intelligence/Solution/{Solution_Name}/Prediction

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    Name Beschreibung
    Solution_Name Name der Lösung, die für Vorhersagen verwendet werden soll. Beispiel: Ml_Incident_Kategorisierung .

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Schlüssel-Wert-Paar des Eingabefelds der Lösungsdefinition Name-Wert-Paar des Lösungseingabefelds. Geben Sie beispielsweise den Namen ein: Short_description Und der Wert: Verbindung mit VPN kann nicht hergestellt werden .

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Eingabe Name-Wert-Paare, die als Eingabe für den Aufruf angegeben wurden.

    Datentyp: Objekt
    Ausgabe Vorhergesagte Ergebniswerte basierend auf der angegebenen Lösung.

    Datentyp: Objekt

    "output": {
  "confidence": Number",
  "outcome": "String",
  "threshold": Number"
}
    Ausgabe.Konfidenz Geschätzte Genauigkeit der Vorhersage als Prozentsatz. Beispiel: 53,84615375762915 .

    Datentyp: Zahl
    Ausgabe.Ergebnis Wert des Vorhersageausgabefelds. Beispielsweise würde eine Incident-Kategorisierungslösung eine Incident-Kategorie wie zurückgeben Anfrage .

    Datentyp: Zeichenfolge
    Ausgabe.Schwellenwert Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist.

    Datentyp: Zahl

    Beispiel für Curl-Anforderung

    curl "https://instance.service-now.com/api/now/predictive_intelligence/solution/ml_incident_categorization/prediction?short_description=unable%20to%20connect%20to%20VPN" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  "result": {
    "input": {
      "short_description": "unable to connect to VPN",
      "api": "api"
    },
    "output": {
      "outcome": "inquiry",
      "confidence": 53.84615375762915,
      "threshold": 5
    }
  }
}

    Predictive Intelligence – GET /Agent_Intelligence/Solution/Prediction

    Gibt Vorhersagen für mehrere Lösungen zurück.

    Hinweis:
    Ergebnisobjekte werden nach Lösungsname und sys_ID im Format gruppiert Result.<solutionname>.<sys_id>.[{ <result1> },{ <result2>}] .

    Informationen zur Anpassung finden Sie unter Skriptfähige MLSolutionFactory-Objekte .

    URL-Format

    Versionierte URL: /Now/{api_Version}/Agent_Intelligence/Solution/Prediction

    Standard-URL: /Now/Agent_Intelligence/Solution/Prediction

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Parameter Beschreibung
    Input_Filter Erforderlicher Parameter, wenn input_tableWird verwendet, verwenden Sie diesen Parameter nicht mit input_mapsParameter. Filter, um Datensätze auszuwählen, für die Vorhersagen ausgeführt werden sollen. Zum Beispiel:
    sys_id 0ef47232db801300864adfea5e961912

    Datentyp: Zeichenfolge
    Input_Maps Erforderlich, sofern nicht verwendet input_tableParameter. Array von Name-Wert-Eingabepaaren. Zum Beispiel: 
    [{"short_description":"my email is not working"}, {"short_description":"need help with password"}]

    Datentyp: Array von Objekten
    Input_table Erforderlich, sofern nicht verwendet input_mapsParameter. Tabellenname, für den Sie Vorhersagen ausführen möchten. Zum Beispiel:
    incident

    Datentyp: Zeichenfolge
    Optionen JSON-Objekt mit optionalen Argumenten. Zum Beispiel:
    {"top_n" : 5, "apply_threshold":false}
    Gültige Optionen:
    • Top_n: Zahl. Wenn angegeben, werden die Top-Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben.
    • Apply_threshold: Boolescher Wert. Überprüft den Schwellenwert für die Lösung und wendet ihn auf den Ergebnissatz an. Der Schwellenwert ist der Lösungsschwellenwert für Ähnlichkeit oder der Schwellenwert auf Klassenebene für die Klassifizierung. Standardwert ist „wahr“.
    • Custom_results_Filter: Zeichenfolge. Nur Ähnlichkeitslösungen. Gibt den zulässigen Satz an, aus dem Ergebnisse mithilfe einer codierten Abfrage zurückgegeben werden.

    Datentyp: Objekt
    Lösungsnamen Erforderlich. Kommagetrennte Liste von Lösungsnamen, für die Sie Vorhersagen ausführen möchten. Zum Beispiel:
    ml_incident_categorization,ml_incident_assignment

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Vertrauen Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53.84.

    Datentyp: Zahl
    DetailedErgebnisse Nur Ähnlichkeitslösungen. JSON-Schlüssel-Wert-Paar mit Details zu den übereinstimmenden Textindizes.

    Datentyp: Zeichenfolge
    PredictedSysId Die sys_ID des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, für die Informationen vorhergesagt werden.

    Datentyp: Zeichenfolge
    Vorhergesagter Wert Wert, der das Vorhersageergebnis darstellt.

    Datentyp: Zeichenfolge
    Schwellenwert Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist.

    Datentyp: Zahl

    Beispiel für Curl-Anforderung

    curl "http://instance.servicenow.com/api/now/agent_intelligence/solution/prediction?input_table=incident&input_filter=sys_id%3D0ef47232db801300864adfea5e961912&solution_names=ml_incident_categorization%2Cml_incident_assignment&options=%7B%22top_n%22%20%3A%202%2C%20%22apply_threshold%22%3Afalse%7D" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "ml_incident_categorization": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 29.12211732875455,
          "threshold": 15,
          "predictedValue": "Email",
          "predictedSysId": ""
        },
        {
          "confidence": 19.08583525847071,
          "threshold": 14,
          "predictedValue": "Platform Performance",
          "predictedSysId": ""
        }
      ]
    },
    "ml_incident_assignment": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 5.782322543467415,
          "threshold": 5,
          "predictedValue": "IT Finance CAB",
          "predictedSysId": "5f63e48fc0a8010e00eeaad81cd4dd37"
        },
        {
          "confidence": 5.303589009246953,
          "threshold": -1,
          "predictedValue": "NY DB",
          "predictedSysId": "5f74727dc0a8010e01efe33a251993f9"
        }
      ]
    }
  }
}