Predictive Intelligence-API

Die Predictive Intelligence -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 das Plugin Predictive Intelligence (com.glide.platform_ml) aktiviert ist.

Predictive Intelligence GET /agent_intelligence/solution/{solution_name}/prediction

Sagt einen Ausgabefeldwert anhand einer bestimmten Lösung vorher.

URL-Format

Standard-URL: /api/now/agent_intelligence/solution/{solution_name}/prediction

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
solution_name	Name der für Vorhersagen zu verwendenden Lösung. Zum Beispiel, ml_incident_categorization. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Schlüsselwertpaar für Lösungsdefinition-Eingabefeld	Name-Wert-Paar des Lösungseingabefelds. Geben Sie beispielsweise den Namen short_description und den Wert Unable to connection to VPN (Verbindung mit VPN kann nicht hergestellt werden)ein. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	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 HTTP-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Eingabe	Name-Wert-Paare, die als Eingabe für den Anruf 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. Zum Beispiel, 53.84615375762915. Datentyp: Zahl
Ausgabe.Ergebnis	Wert des Ausgabefelds der Vorhersage Beispielsweise würde eine Incident-Kategorisierungslösung eine Incident-Kategorie wie inquiry zurückgeben. Datentyp: Zeichenfolge
Ausgabe.Schwellenwert	Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist. Datentyp: Zahl

Beispiel für eine 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:

Ergebnisergebnisobjekte werden nach Lösungsname und sys_id im Formatergebnis gruppiert .<solutionname> .<sys_id> .[{<result1> }, {<result2> }] .

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

URL-Format

URL mit Versionsnummer: /now/{api_version}/agent_intelligence/solution/prediction

Standard-URL: /now/agent_intelligence/solution/prediction

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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_table verwendet wird, verwenden Sie diesen Parameter nicht mit dem Parameter input_maps. Filtern Sie, 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 Parameter input_table verwendet wird. Array von eingegebenen Name/Wert-Paaren. Zum Beispiel: [{"short_description":"my email is not working"}, {"short_description":"need help with password"}] Datentyp: Array von Objekten
input_table	Erforderlich, sofern nicht Parameter input_maps verwendet wird. Name der Tabelle, für die Vorhersagen ausgeführt werden sollen. 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 besten Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben. anwenden_threshold: Boolesch. Ü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. Der Standardwert ist „true“. 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
solution_names	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. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	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 HTTP-Antwortcodes der REST-API.

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen 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. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
confidence	Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53,84. Datentyp: Zahl
detaillierteErgebnisse	Nur Ähnlichkeitslösungen. JSON-Schlüssel-Wert-Paar, das Details zu den übereinstimmenden Textindizes enthält. Datentyp: Zeichenfolge
vorhergesagteSysId	Die sys_id des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, in der Informationen vorhergesagt werden. Datentyp: Zeichenfolge
„predictedValue“	Wert, der das Vorhersageergebnis darstellt. Datentyp: Zeichenfolge
Schwellenwert	Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist. Datentyp: Zahl

Beispiel für eine 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"
        }
      ]
    }
  }
}