KI-Assets-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 62 Minuten Lesedauer

    • KI-Assets Die API stellt Endpunkte zum Abrufen, Aktualisieren und Erstellen verschiedener Arten von KI-Assets bereit, z. B. Systeme, Datensätze, Eingabeaufforderungen und Modelle.

    Die KI-Assets Die API unterstützt Aktionen, die Sie für KI-Asset-Datensätze in der erweiterten Anwendung „Modell“ und „Asset-Klassen“ ausführen können. Für den Zugriff darauf ist das Plugin „Asset Classes“ (sn_ent) erforderlich. Sie müssen über die Rollen „Asset“ und „model_Manager“ verfügen, um die von der API für KI-Assets bereitgestellten Endpunkte aufzurufen.
    Hinweis:
    Die in KI-Asset-Datensätzen enthaltenen Daten können auf mehrere Tabellen wie Produktmodell, Konfigurationselement und andere verteilt werden. Um die Komplexität beim Aufrufen dieser API zu reduzieren, ist jedoch der KI-Assets Die API fügt Daten nur in die Tabellen „Asset“, „Produktmodell“ und „Konfigurationselement“ ein. Spezifische Informationen zu Tabellenaktualisierungen werden unter jedem Endpunkt bereitgestellt.

    KI-Assets-API – GET /sn_ent/Asset/ai_Dataset/{sys_ID}

    Ruft die Daten des angegebenen KI-Datensatz-Assets ab.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_Dataset/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_Dataset/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    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ützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur 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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Details des neu erstellten KI-Datensatz-Assets.

    Datentyp: Objekt

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    Ergebnis.Acceptable_usage Zulässige Nutzung für den Datensatz „KI-Datensatz-Asset“. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Bewertungszwecken.

    Datentyp: Objekt

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    Ergebnis.Acceptable_usage.label Bezeichnung des zulässigen Nutzungswerts anzeigen.

    Datentyp: Zeichenfolge
    Ergebnis.Acceptable_usage.value Der Zweck des Datensatzes oder Modells, z. B. für Schulungen oder Bewertungen.
    Gültige Werte:
    • 1 : Gibt den Schulungszweck an
    • 2 : Gibt einen Bewertungszweck an

    Datentyp: Zeichenfolge (Zahl)
    Result.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_ID eines Basisdatensatzes in der Tabelle „Digitales KI-Datensatz-Asset“ [alm_ai_Dataset_digital_Asset].

    Datentyp: Array

    "base_datasets": ["String", "String"]
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
  "label": "String",
  "value": "String"
}
    Ergebnis.Data_type.label Die Anzeigebezeichnung für den Datentypwert.

    Datentyp: Zeichenfolge
    Ergebnis.Data_type.value Wert des Datentyps des Datensatz-Assets.

    Datentyp: Zeichenfolge
    Ergebnis.Datensatz_Karte Die Datensatzkarte. Eine Dataset_Card ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es enthält Details wie Datenquellen, Funktionen, beabsichtigte Verwendung und alle bekannten Einschränkungen, um ein ordnungsgemäßes Verständnis und eine ordnungsgemäße Nutzung sicherzustellen.

    Datentyp: Zeichenfolge
    result.description Beschreibung des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Anzeigename Anzeigename des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_Dataset_Product_model].

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Details zum Anwender, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name Name des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID SYS_ID des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.name Name des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider Anbieter des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name Name des Anbieters.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz „KI-Datensatz-Produktmodell“.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Quelle Details zur Quelle des KI-Datensatz-Assets.
    Gültige Werte:
    • Link zur Quelle des Datensatz-Assets.
    • Details (in nur-Text) der Quelle des Datensatz-Assets. Zum Beispiel der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    Ergebnis.Status Status des KI-Datensatz-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Versionsnummer des zugehörigen Datensatzes für KI-Datensatz-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel.

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/ cc419cb2331e92101c9aca989d5c7b4c" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

    Ausgabe:

    { 
  "result": { 
    "sys_id": "9d60fb5f40d21210f877b00c113d1fea", 
    "display_name": "ServiceNow Closed Incidents v1", 
    "name": "Closed Incidents", 
    "description": "Incidents with resolution", 
    "documentation": "Sample Documentation", 
    "source": "incident table on servicenow instance", 
    "dataset_card": "Sample Dataset Card", 
    "state": "Development", 
    "version": "v1", 
    "data_type": { 
      "value": "2", 
      "label": "Image" 
    }, 
    "provider": { 
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
      "name": "ServiceNow" 
    }, 
    "managed_by": { 
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
      "name": "Abel Tuter" 
    }, 
    "acceptable_usage": { 
      "value": "1", 
      "label": "Training" 
    }, 
    "base_datasets": [], 
    "created": "2024-12-11 08:50:40", 
    "updated": "2024-12-11 08:50:40" 
  } 
}

    KI-Assets-API – GET /sn_ent/Asset/ai_model/{sys_ID}

    Ruft die Daten des angegebenen KI-Modell-Assets ab.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_model/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_model/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    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ützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur 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 REST API-HTTP-Antwortcodes .

    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. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts
    Ergebnis Details des Modell-Asset-Datensatzes.

    Datentyp: Objekt

    result: {
  "base_model": {Object},
  "context_window": "String",
  "created": "String",
  "deployment_guideline": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": {Object},
  "model_size_in_mb": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": {Object},
  "required_infrastructure": "String",
  "source": "String",
  "state": Number,
  "supported_languages": [Array],
  "sys_id": "String",
  "training_datasets": [Array],
  "training_procedure": "String",
  "updated": "String",
  "version": "String"
}
    Ergebnis.Base_model KI-Modell, von dem diese Modellversion abgeleitet wurde.
    Hinweis:
    Gilt nur für Modelle, die innerhalb der Organisation entwickelt wurden.

    Datentyp: Objekt

    {
  "name": "String",
  "sys_id": "String"
 }
    Standard:
    result.base_model.name Name des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Datentyp: Zeichenfolge
    Ergebnis.Base_model.sys_ID SYS_ID des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Tabelle: KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Kontext_Fenster Größe der Eingabesequenzen (in anderen Worten die Anzahl der Token), die das Modell verarbeiten kann.

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.deployment_guideline Anweisungen, die für Modelle gelten, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zeichenfolge
    result.description Beschreibung, um das KI-Modell-Produktmodell anzugeben.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Eingabeaufforderung – Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_Datasets Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen KI-Datensatzes, das zur Auswertung des Modells verwendet wird.

    Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Datentyp: Array

    "evaluation_datasets": [
  "name": "String",
  "sys_id": "String"
]
    Ergebnis.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Details zum Anwender, der den Asset-Datensatz des KI-Modells verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name Name des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID SYS_ID des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.model_size_in_mb Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zahl
    result.name Erforderlich. Name des KI-Modell-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Parameter_Info Eigenschaften der Trainingsdaten, die während des Lernprozesses lernen. Beispiel: 7B Oder 30B .

    Datentyp: Zeichenfolge
    result.provider Anbieter des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name Name des Anbieters.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz „KI-Datensatz-Produktmodell“.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.required_Infrastructure Dokumentation des Infrastrukturbedarfs für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die in einer Organisation bereitgestellt werden.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis.Anzeigename Anzeigename des Asset-Datensatzes.

    Datentyp: Zeichenfolge
    Ergebnis.Quelle Details zur Quelle des Modells.
    Mögliche Werte:
    • Link zur Quelle des Modells. Beispiel: https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Oder ein Link zu Github.
    • Details der Quelle in nur-Text. Beispiel: Microsoft Azure

    Datentyp: Zeichenfolge
    Ergebnis.Status Status, der auf das KI-Modell-Asset angewendet werden soll.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.unterstützte_Sprachen Sprachen, die vom KI-Modell unterstützt werden.

    Datentyp: Array

    "supported_languages": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.supported_languages.name Name des Sprachdatensatzes. Beispiel: „Französisch“, „Englisch“ .

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.unterstützte_Sprachen.sys_ID SYS_ID des Sprachdatensatzes.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des Asset-Datensatzes des KI-Modells.

    Tabelle: KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Training_Datasets Verweis auf 1+ zugeordnete Datensätze, die zum Trainieren des Modells verwendet werden.

    Datentyp: Array

    "training_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    Ergebnis.Training_procedure Typ des KI-Trainings, das auf das Modell angewendet wird.
    Mögliche Werte:
    • 1: Entscheidungsstrukturen
    • 2: Tiefe Neuronale Netzwerke
    • 3: Lineare Regression
    • 4: Logistische Regression
    • 5: Zufällige Gesamtstruktur
    • 6: Überwachtes Lernen
    • 7: Nicht Überwachtes Lernen
    • 8: Verstärkungslernen
    • 9: Lerninhalte Übertragen
    • 10: Halbüberwachtes Lernen
    • 11: Feinabstimmung Von Anweisungen
    • 12: Überwachte Feinabstimmung

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Version für KI-Modell-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel.

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_model/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Ausgabe:

    {
  "result": {
    "sys_id": "a438d170ff96da10c1fbffffffffffd5",
    "display_name": "ServiceNow Now LLM V6",
    "name": "Now LLM",
    "description": "enables text-to-text like question answering and summarization",
    "version": "V6",
    "provider": {
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
      "name": "ServiceNow"
    },
    "documentation": "Now LLM V5 Documentation",
    "parameters_info": "7B",
    "supported_languages": [
      {
        "sys_id": "914493a30f320010e96b0e4fef767e90",
        "name": "English"
      }
    ],
    "model_size_in_mb": "87",
    "deployment_guideline": "Deployed on ServiceNow infrastructure",
    "source": null,
    "training_procedure": "2",
    "context_window": "8000",
    "state": "Deployed",
    "required_infrastructure": "undefined",
    "base_model": {
      "sys_id": null,
      "name": ""
    },
    "evaluation_datasets": [
      {
        "sys_id": "45cb45baff06d610c1fbffffffffffa9",
        "name": "ServiceNow Open Incidents"
      }
    ],
    "training_datasets": [
      {
        "sys_id": "45cb45baff06d610c1fbffffffffffa9",
        "name": "ServiceNow Open Incidents"
      }
    ],
    "evaluation_metrics_report": "Testing results: See files attached to this record",
    "managed_by": {
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
      "name": "Abel Tuter"
    },
    "created": "2024-12-03 16:50:53",
    "updated": "2024-12-03 16:50:53"
  }
}

    KI-Assets-API – GET /sn_ent/Asset/ai_prompt/{sys_ID}

    Ruft die Daten des angegebenen KI-Prompt-Assets ab.

    Siehe auch:

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_prompt/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_prompt/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. 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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Details zum KI-Prompt-Asset.
    result: {
  "ai_model": {Object},
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "managed_by": {Object},
  "name": "String",
  "prompt_info": "String",
  "provider": {Object},
  "state": Number,
  "sys_id": "String",
  "updated": "String",
  "version": "String"
}
    Ergebnis.KI_model KI-Modell des KI-Prompt-Asset-Datensatzes.

    Datentyp: Objekt

    "ai_model": {
  "name": "String",
  "sys_id": "String"
}
    result.ai_model.name Name des KI-Modells.

    Datentyp: Zeichenfolge
    Ergebnis.KI_model.sys_ID SYS_ID des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Eingabeaufforderung – Produktmodell [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-Prompt-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.description Beschreibung des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Anzeigename Anzeigename des zugehörigen KI-Prompt-Asset-Datensatzes.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation für den Datensatz des KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Anwender, der den Datensatz des KI-Prompt-Assets verwaltet.

    Datentyp: Objekt

    "managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.managed_by.name Name des Anwenders, der den Asset-Datensatz verwaltet.

    Tabellen: Anwender [sys_user], KI-Aufforderungs-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID SYS_ID des Anwenderdatensatzes, der dem Anwender „verwaltet von“ des Asset-Datensatzes entspricht.

    Tabellen: Anwender [sys_user], KI-Aufforderungs-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    result.name Name des zugehörigen KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge
    result.prompt_info Aufforderungsinformationen des KI-Aufforderungs-Asset-Datensatzes.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    result.provider Anbieter des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    "provider": {
  "name": "String",
  "sys_id": "String"
}

    Datentyp: Objekt
    result.provider.name Name des zugehörigen Datensatzes für KI-Prompt-Produktmodell.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge
    result.provider.sys_id SYS_ID des Unternehmens-Tabellendatensatzes, der dem Anbieter des zugehörigen KI-Prompt-Produktmodelldatensatzes entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Status Status des KI-Prompt-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des KI-Prompt-Asset-Datensatzes.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Prompt-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Version des zugehörigen Datensatzes für KI-Prompt-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Informationen zu einem KI-Prompt-Asset-Modell mithilfe einer bestimmten ID abgerufen werden.

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Der Antworttext gibt Details zum spezifischen Prompt-Asset-Modell zurück, das abgerufen wurde.

    {
  "result": {
    "sys_id": "cc419cb2331e92101c9aca989d5c7b4c",
    "display_name": "ServiceNow ServiceNow Incident Summarization Prompt 4 V8",
    "name": "ServiceNow Incident Summarization Prompt 4",
    "description": "Prompt for Incident Summarization",
    "version": "V8",
    "provider": {
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
      "name": "ServiceNow"
    },
    "documentation": "Documentation",
    "state": "Development",
    "ai_model": {
      "sys_id": "a57d0be6eb1e5210aa82fab8bad0cd18",
      "name": "mistral-large"
    },
    "prompt_info": "Provide incident summary using short_decription, state, worknotes",
    "managed_by": {
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
      "name": "Abel Tuter"
    },
    "created": "2024-12-09 03:18:46",
    "updated": "2024-12-09 04:26:08"
  }
}

    KI-Assets-API – GET /sn_ent/Asset/ai_System/{sys_ID}

    Ruft die Daten des angegebenen KI-System-Assets ab.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_System/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_System/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. 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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Details zum abgerufenen KI-System-Asset.
    result: {
  "ai_models": [Array],
  "ai_prompts": [Array],
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": Number,
  "sys_id": "String",
  "updated": "String",
  "version": "String"
}
    Ergebnis.KI_Modelle Liste der KI-Modelle im Datensatz „Digitales KI-System-Asset“.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_models.name Name des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.KI_Modelle.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.KI_Prompts Liste der KI-Hinweismeldungen im Datensatz „KI-System-Asset“.

    Datentyp: Array

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_prompts.name Name des KI-Prompts.

    Datentyp: Zeichenfolge
    Ergebnis.KI_Prompts.sys_ID SYS_ID des Datensatzes des digitalen KI-Prompt-Assets.

    Tabelle: Digitales KI-Prompt-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-System-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.description Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Anzeigename Anzeigename des KI-System-Asset-Datensatzes.

    Tabelle: KI-System-Asset [cmdb_ai_ System_Asset_model]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation für den Datensatz des KI-Systemprodukts.

    Tabelle: KI-System-Produktsystem [cmdb_ai_System_Product_System]

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_Datasets Liste der KI-Datensätze, die für die Bewertung des Modells im Datensatz des digitalen KI-Systems verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], KI-System-Asset [alm_ai_System_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]

    Standard: Leere Zeichenfolge
    result.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen KI-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_metrics_Report Auswertungsergebnisse des KI-System-Asset-Datensatzes.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Details zum Anwender, der den KI-System-Asset-Datensatz verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name SYS_ID des Anwenders, der den KI-System-Asset-Datensatz verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID Name des Anwenders, der den KI-System-Asset-Datensatz verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.name Name des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.provider Wert des Felds Provider im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name Name des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Status Status des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-System-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Versionsnummer des zugehörigen Datensatzes des KI-Systemproduktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein KI-Systemmodell-Asset mit einer bestimmten ID abgerufen wird.

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_system/3b140397435a9210a63d00002fb8f2d7" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Der Antworttext gibt Details zum angegebenen KI-Systemmodell-Asset zurück.

    {
  "result": {
      "sys_id": "3b140397435a9210a63d00002fb8f2d7",
      "display_name": "ServiceNow Incident Summarization V2",
      "name": "Incident Summarization",
      "description": "Incident Summarization Skill",
      "version": "V2",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Sample Documentation",
      "state": "Deployed",
      "ai_models": [{ 
        "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "llm_generic_small" 
      },
      { 
        "sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "mixtral-instruct" 
      }],
      "ai_prompts": [{ 
        "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "LLM Prompt" 
      }],
      "evaluation_datasets": [{ 
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "Base dataset" 
      }],
      "evaluation_metrics_report": "Sample Report",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-11 18:23:09",
      "updated": "2024-12-11 18:23:09"
  }
}

    KI-Assets-API – POST /sn_ent/Asset/ai_Dataset

    Erstellt einen neuen KI-Datensatz-Asset-Eintrag im digitalen KI-Datensatz-Asset [alm_ai_dataset_digital_Asset] und im KI-Datensatz-Produktmodell [cmdb_ai_dataset_Product_model] gemäß den Details, die Sie im Anforderungstext angeben.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_Dataset

    Standard-URL: /api/sn_ent/Asset/ai_Dataset

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    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 : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    {Object} 
    {
  "acceptable_usage": "String",
  "base_datasets": [Array],
  "dataset_card": "String"
  "data_type": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String", 
  "name": "String", 
  "provider": "String",
  "state": "String" 
  "source": "String",
  "version": "String"
}
    {Object}.acceptable_usage Der Zweck des Datensatzes oder Modells, z. B. für Schulungen oder Bewertungen.
    Gültige Werte:
    • 1 : Gibt den Schulungszweck an
    • 2 : Gibt einen Bewertungszweck an

    Datentyp: Zeichenfolge (Zahl)
    {Object}.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieses Datensatzes erforderlich sind. Akzeptiert Namen oder sys_IDs von Datensätzen, die in der Tabelle „Digitales KI-Datensatz-Asset“ [alm_ai_Dataset_digital_Asset] vorhanden sind.

    Datentyp: Array

    “base_datasets”: ["String", “String"]
    {Object}.Data_type Typ der im Datensatz vorhandenen Daten. Beispiel: Text, Video, Bild Oder 1,2 .

    Datentyp: Zeichenfolge
    {Object}.Dataset_Card Die Datensatzkarte. Eine Dataset_Card ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es enthält Details wie Datenquellen, Funktionen, beabsichtigte Verwendung und alle bekannten Einschränkungen, um ein ordnungsgemäßes Verständnis und eine ordnungsgemäße Nutzung sicherzustellen.

    Datentyp: Zeichenfolge
    {Object}.description Beschreibung des zugehörigen KI-Datensatz-Produktmodells.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Dokumentation Dokumentation für das Produktmodell des KI-Datensatzes.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Managed_by SYS_ID oder Namenswert des Anwenders im Feld verwaltet von des Datensatzes „KI-Datensatz-Produktmodell“.

    Tabellen: Anwender [sys_user], KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_Dataset_Product_model].

    Datentyp: Zeichenfolge
    {Object}.Provider Erforderlich. SYS_ID- oder Namenwert des Felds „Anbieter“ des Datensatzes der Tabelle „Unternehmen“ [Core_Company].

    Datentyp: Zeichenfolge
    {Object}.Source Details zur Quelle des Datensatzes.
    Gültige Werte:
    • Link zur Quelle des Datensatzes.
    • Details der Quelle in nur-Text.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    {Object}.State Status des KI-Datensatz-Assets.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    {Object}.Version Versionsnummer des zugehörigen Datensatzes für KI-Datensatz-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Header

    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 : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Details des neu erstellten KI-Datensatz-Assets.

    Datentyp: Objekt

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    Ergebnis.Acceptable_usage Zulässige Nutzung für den Datensatz „KI-Datensatz-Asset“. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Bewertungszwecken.

    Datentyp: Objekt

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    Ergebnis.Acceptable_usage.label Bezeichnung des zulässigen Nutzungswerts anzeigen.

    Datentyp: Zeichenfolge
    Ergebnis.Acceptable_usage.value Der Zweck des Datensatzes oder Modells, z. B. für Schulungen oder Bewertungen.
    Gültige Werte:
    • 1 : Gibt den Schulungszweck an
    • 2 : Gibt einen Bewertungszweck an

    Datentyp: Zeichenfolge (Zahl)
    Result.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_ID eines Basisdatensatzes in der Tabelle „Digitales KI-Datensatz-Asset“ [alm_ai_Dataset_digital_Asset].

    Datentyp: Array

    "base_datasets": ["String", "String"]
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
  "label": "String",
  "value": "String"
}
    Ergebnis.Data_type.label Die Anzeigebezeichnung für den Datentypwert.

    Datentyp: Zeichenfolge
    Ergebnis.Data_type.value Wert des Datentyps des Datensatz-Assets.

    Datentyp: Zeichenfolge
    Ergebnis.Datensatz_Karte Die Datensatzkarte. Eine Dataset_Card ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es enthält Details wie Datenquellen, Funktionen, beabsichtigte Verwendung und alle bekannten Einschränkungen, um ein ordnungsgemäßes Verständnis und eine ordnungsgemäße Nutzung sicherzustellen.

    Datentyp: Zeichenfolge
    result.description Beschreibung des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Anzeigename Anzeigename des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_Dataset_Product_model].

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Details zum Anwender, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name Name des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID SYS_ID des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.name Name des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider Anbieter des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz „KI-Datensatz-Produktmodell“.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider.name Name des Anbieters.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Quelle Details zur Quelle des KI-Datensatz-Assets.
    Gültige Werte:
    • Link zur Quelle des Datensatz-Assets.
    • Details (in nur-Text) der Quelle des Datensatz-Assets. Zum Beispiel der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    Ergebnis.Status Status des KI-Datensatz-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Versionsnummer des zugehörigen Datensatzes für KI-Datensatz-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge
    Ergebnis.Warnungen Kommagetrennte Liste von Warnmeldungen, die beim Erstellen des Datensatzes vorhanden sind. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie einen neuen KI-Datensatz-Asset-Datensatz erstellen.

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' { 
  "name": "Dataset One", 
  "description": "Description for dataset ", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  "source”: "Source of dataset”,
  "documentation": "document", 
  "dataset_card”: "Dataset Card”, 
  "base_datasets”: ["Dataset Two”, "Dataset Three”], 
  "data_type”: "1,2”, 
  "acceptable_usage”: "1,2”, 
  "managed_by": "abel.tuter" 
}'

    Antworttext. Die Ergebnisse des neu erstellten Datensatz-Asset-Datensatzes.

    { 
  "result": { 
    "asset": { 
      "sys_id": "da8393eb40d25210f877b00c113d1fc1", 
      "display_name": "ServiceNow Closed Incidents", 
      "name": "Closed Incidents", 
      "description": "Incidents with resolution", 
      "documentation": "Sample Documentation", 
      "source": "incident table on servicenow instance", 
      "dataset_card": "Dataset Card", 
      "state": "Deployed", 
      "version": null, 
      "data_type": { 
        "value": "1", 
        "label": "Text" 
      }, 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "managed_by": { 
        "sys_id": "undefined", 
        "name": "" 
      }, 
      "acceptable_usage": { 
        "value": "1", 
        "label": "Training" 
      }, 
      "base_datasets": [], 
      "created": "2024-12-12 01:23:03", 
      "updated": "2024-12-12 01:23:03" 
    }, 
    "warnings": [] 
       } 
}

    KI-Assets-API – POST /sn_ent/Asset/ai_prompt

    Erstellt einen neuen KI-Prompt-Asset-Eintrag in den Tabellen „Digitales Asset der KI-Eingabeaufforderung“ [alm_ai_prompt_digital_Asset] und „Produktmodell der KI-Eingabeaufforderung“ [cmdb_ai_promt_Product_model] gemäß den Details, die Sie im Anforderungstext angeben.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_prompt

    Standard-URL: /api/sn_ent/Asset/ai_prompt

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    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 : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Inhalt des zu aktualisierenden KI-Prompt-Assets.

    Datentyp: Objekt

    {
  "ai_model": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String" 
  "name": "String",
  "prompt_info": "String", 
  "provider": "String",
  "state": Number,
  "version": "String"
}
    KI_model Name des sys_ID-Werts des Felds KI-Modell im Datensatz des digitalen KI-Modells.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Beschreibung Beschreibung, die das KI-Prompt-Produktmodell bereitstellt.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Dokumentation Dokumentation des KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    managed_by Name oder sys_ID des Anwenders, der das Asset verwaltet. Befindet sich im Feld verwaltet von des Asset-Datensatzes.

    Tab;e: Anwender [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Prompt-Produktmodell“ [cmdb_ai_prompt_Product_model].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Prompt_info Prompt-Informationen für KI-Prompt-Asset.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Anbieter Erforderlich. Anbietername oder sys_ID des Unternehmens-Tabellendatensatzes.

    Tabelle: Unternehmen [Core_Company]

    Datentyp: Zeichenfolge
    Status Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel:
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Version Versionsnummer zum Zuweisen des KI-Prompt-Produktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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 : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 35. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnisse des neuen KI-Asset-Prompts.

    Datentyp: Objekt

    "result": { 
    "asset": Object, 
    "warnings": [Array] 
 }
    Ergebnis.Asset Details zum neu erstellten Eintrag.

    Datentyp: Objekt

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    Ergebnis.Asset.KI_model Liste der KI-Modelle im Datensatz der Tabelle „KI-System-Asset“.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_model": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name Name des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Models.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Prompts Liste der KI-Hinweismeldungen des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_prompts.name Name des KI-Prompts.

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Prompts.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets Liste der sys_IDs oder Anzeigenamen der KI-Datensätze, die zum Auswerten des KI-System-Asset-Modells verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], digitales KI-System-Asset [alm_ai_System_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_metrics_Report Auswertungsergebnisse des KI-System-Assets.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Details zum Anwender, der das Asset verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.asset.name Name des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider Wert des Anbieterfelds im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Warnung Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie die POST-Methode verwenden, um einen neuen KI-Prompt gemäß den Details im Anforderungstext zu erstellen.

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization prompt1", 
  "description": "Prompt for Incident Summarization", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  "documentation": "Document", 
  "ai_model": "mixtral-instruct", 
  "prompt_info": "Provide incident summary using short_decription, state, worknotes", 
  "managed_by": "abel.tuter" 
 }'

    Antworttext.

    { 
  "result": { 
    "asset": { 
      "sys_id": "9833721b331e92101c9aca989d5c7bf0", 
      "display_name": "ServiceNow Incident Summarization prompt1 V1", 
      "name": "Incident Summarization prompt1", 
      "description": "Prompt for Incident Summarization", 
      "version": "V1", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Document", 
      "state": "Deployed", 
      "ai_model": { 
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "mixtral-instruct" 
      }, 
      "prompt_info": "Provide incident summary using short_decription, state, worknotes", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-11 04:23:17", 
      "updated": "2024-12-11 04:23:17" 
    }, 
    "warnings": [] 
  } 
}

    KI-Assets-API – POST /sn_ent/Asset/ai_model

    Erstellt einen neuen KI-Modell-Asset-Eintrag in den Tabellen „Digitales KI-Modell“ [alm_ai_model_digital_Asset] und „KI-Modell-Produktmodell“ [cmdb_ai_model_Product_model] gemäß den Details, die Sie im Anforderungstext angeben.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_model

    Standard-URL: /api/sn_ent/Asset/ai_model

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    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 : 38. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    {Object} Erforderlich. Details, die auf den neuen Asset-Modelldatensatz angewendet werden sollen.

    Datentyp: Objekt

    "object": {
  "base_model": {Object},
  "context_window:" "String",
  "deployment_guideline": "String",
  "description": "String", 
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": "String", 
  "model_size_in_mb": "String",
  "model_weights_info": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": "String",
  "required_infrastructure": "String",
  "source": "String",
  "state": Number,
  "supported_languages: [Array],
  "training_datasets": [Array],
  "training_procedure": "String",
  "version": "String"
}
    {Object}.Base_model KI-Modell, von dem diese Modellversion abgeleitet wurde.
    Hinweis:
    Gilt nur für Modelle, die innerhalb der Organisation entwickelt wurden.

    Datentyp: Objekt

    {
  "name": "String",
  "sys_id": "String"
 }
    {Object}.base_model.name Name des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Datentyp: Zeichenfolge
    {Object}.Base_model.sys_ID SYS_ID des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.context_window Größe der Eingabesequenzen (in anderen Worten die Anzahl der Token), die das Modell verarbeiten kann.

    Datentyp: Ganzzahl

    Standard: Leerer Wert
    {Object}.Deployment_Guideline Anweisungen, die für Modelle gelten, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.description Beschreibung, um das KI-Modell-Produktmodell anzugeben.

    Aktualisierte Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.Dokumentation Dokumentation des KI-Modell-Produktmodells.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.Evaluation_Datasets Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen der KI-Datensätze, die für die Auswertung des Modells verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset], KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": ["String", "String"]
    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Datensatzes.
    • SYS_ID des Datensatzes des digitalen KI-Datensatzes.

    Standard: Leere Zeichenfolge
    {Object}.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse, die sich im Textfeld des digitalen Asset-Datensatzes des KI-Modells befinden. Zum Beispiel:
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.Managed_by Wert des Felds „verwaltet von“ eines vorhandenen Datensatzes in der Anwendertabelle [sys_user].
    Gültige Werte:
    • Name des Anwenderdatensatzes [sys_user]
    • SYS_ID des Anwenderdatensatzes [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.model_size_in_mb Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zahl

    Standard: Null oder leer
    {Object}.model_weight_info Zusätzliche Modellinformationen, falls verfügbar. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Datentyp: Zeichenfolge

    Standard: Null oder leer
    {Object}.Name Erforderlich. Name des KI-Modell-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge

    Standard: Null oder leer
    {Object}.Parameters_info Anzahl der Parameter, die für das Modell angegeben werden.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.Provider Erforderlich. SYS_ID oder Name des Anwenders, der das Feld Provider im Datensatz „KI-Modell-Produktmodell“ zugewiesen werden soll.

    Tabelle: Unternehmen [Core_Company]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    {Object}.required_Infrastructure Dokumentation des Infrastrukturbedarfs für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die in einer Organisation bereitgestellt werden.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    {Object}.Source Details zur Quelle der Person oder der Person, die das Modell erstellt hat.
    Gültige Werte:
    • Link zur Quelle des Modells. Beispiel: https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Oder ein Link zu Github.
    • Details der Quelle in nur-Text. Beispiel: Microsoft Azure

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    {Object}.State Status, der auf das KI-Modell-Asset angewendet werden soll.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    {Object}.supported_languages Kommagetrennte Liste von Sprachen, die vom KI-Modell unterstützt werden.

    Datentyp: Array

    "supported_languages": [
  "String",
  "String"
]
    Gültige Werte:
    • SYS_ID des Datensatzes „Sprache“ [sys_language].
    • Name des Sprachdatensatzes [sys_language]. Beispiel: „Französisch“, „Englisch“ .

    Standard: Leere Zeichenfolge
    {Object}.Training_Datasets Datensätze, die zum Trainieren des KI-Modells verwendet werden. Kommagetrennte Liste von sys_IDs oder Anzeigenamen der Tabelle „KI-Datensatz-Asset“ [alm_ai_Datensatz_digital_Asset]. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Datentyp: Array

    "training_datasets": [
  "String",
  "String"
]

    Standard: Leere Zeichenfolge
    {Object}.Training_procedure Zahl, die die Art des Trainings angibt, das auf das KI-Modell angewendet werden soll.
    Gültige Werte:
    • 1 : Entscheidungsstrukturen
    • 2 : Tiefenneuronale Netzwerke
    • 3 : Lineare Regression
    • 4 : Logistische Regression
    • 5 : Zufällige Gesamtstruktur
    • 6 : Überwachtes Lernen
    • 7 : Nicht Überwachtes Lernen
    • 8 : Erstärkungslernen
    • 9 : Lernen Übertragen
    • 10 : Semi-Überwachtes Lernen
    • 11 : Feinabstimmung Der Anweisung
    • 12 : Überwachte Feinabstimmung

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird (z. B. „3“ )

    Standard: 1: Entscheidungsstrukturen
    {Object}.Version Version für KI-Modell-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Antworttext-Parameter (JSON oder XML)

    Header

    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 : 40. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 41. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnisse der Asset-Erstellung des KI-Modells.

    Datentyp: Objekt

    "result": { 
    "asset": Object, 
    "warnings": [Array], 
 }
    Ergebnis.Asset Details zum erstellten KI-Modell-Asset.

    Datentyp: Objekt

    "asset": {
  "base_model": Object,
  "context_window": String,
  "created": "String",
  "deployment_guideline": String,
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "model_size_in_mb": String,
  "name": "String",
  "parameters_info": "String",
  "provider": Object,
  "required_infrastructure": String,
  "state": "String",
  "source": String, 
  "supported_languages": Array,
  "sys_id": "String",
  "training_datasets": Array,
  "training_procedure": String,
  "updated": "String",
  "version": "String"
}
    Ergebnis.Asset.Base_model Informationen zum Asset des KI-Modells, von dem diese Version abgeleitet wurde.

    Datentyp: Objekt

    "base_model": { 
  "name": "String",
  "sys_id": "String"
}
    result.asset.base_model.name Anzeigename des KI-Modell-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Base_model.sys_ID SYS_ID des KI-Modell-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Kontext_Fenster Größe der Eingabesequenzen, die das Modell verarbeiten kann. Mit anderen Worten: Die Anzahl der Token.

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird. Beispiel: „6000“ .
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.deployment_guideline Anweisungen, die für Modelle gelten, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-Modell-Asset-Datensatzes.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset] (Feld „Display_Name“)

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets KI-Datensätze, die für die Bewertung des Modells verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_Datasets.sys_ID SYS_ID des digitalen Asset-Datensatzes des KI-Modells.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Anwender, der den Asset-Datensatz des KI-Modells verwaltet.

    Datentyp: Objekt

    " managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.managed_by.name Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.model_size_in_mb Größe des Modells in MB. Gilt normalerweise für Modelle, die in einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl
    result.asset.name Name des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider Anbieter des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Objekt

    "provider": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Unternehmensdatensatzes, der dem Anbieter des zugehörigen Datensatzes für das KI-Modell-Produktmodell entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Unternehmensdatensatzes, der dem Anbieter des zugehörigen KI-Modell-Produktmodelldatensatzes entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Quelle Details zur Quelle des Assets.
    Gültige Werte:
    • Link zur Quelle des Modells. Beispiel: https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Oder ein Link zu Github.
    • Details der Quelle in nur-Text. Beispiel: Microsoft Azure

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    result.asset.supported_languages.name Name der unterstützten Sprache.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages.sys_ID SYS_ID der unterstützten Sprache.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-Modell-Asset-Datensatzes

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Training_Datasets Verweis auf 1+ zugeordnete Datensätze, die zum Trainieren des Modells verwendet werden.

    Datentyp: Array

    "training_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    Ergebnis.Asset.Training_procedure Ein numerischer Wert, der den Typ des auf das Modell angewendeten KI-Trainings angibt.
    Mögliche Werte:
    • 1 : Entscheidungsstrukturen
    • 2 : Tiefenneuronale Netzwerke
    • 3 : Lineare Regression
    • 4 : Logistische Regression
    • 5 : Zufällige Gesamtstruktur
    • 6 : Überwachtes Lernen
    • 7 : Nicht Überwachtes Lernen
    • 8 : Erstärkungslernen
    • 9 : Lernen Übertragen
    • 10 : Semi-Überwachtes Lernen
    • 11 : Feinabstimmung Der Anweisung
    • 12 : Überwachte Feinabstimmung

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Version Version des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model table]

    Datentyp: Zeichenfolge
    Ergebnis.required_Infrastructure Dokumentation des Infrastrukturbedarfs für die Bereitstellung des Modells. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen.

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Parameter_Info Eigenschaften der Trainingsdaten, die während des Lernprozesses lernen. Beispiel: 7B Oder 30B .

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages Details zu den vom KI-Modell-Asset unterstützten Sprachen.

    Tabelle: Sprache [sys_language]

    Datentyp: Objekt

    "supported_languages": [
 { 
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.supported_languages.name Name der Sprache, die vom Asset unterstützt wird.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages.sys_ID SYS_ID der Sprache, die vom Asset unterstützt wird.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Warnungen Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sysId eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Im folgenden Beispiel wird ein KI-Modell-Asset gemäß den im Anforderungstext angegebenen Details erstellt.

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "name": "Now LLM",
  "description": "enables text-to-text like question answering and summarization",
  "provider": "servicenow",
  "documentation": "Now LLM V5 Documentation",
  "version": "V8",
  "parameters_info": "7B",
  "supported_languages": [
    "English",
    "French"
  ],
  "model_size_in_mb": "87",
  "deployment_guideline": "Deployed on ServiceNow infrastructure",
  "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
  "training_procedure": "2",
  "context_window": "8000",
  "state": "31",
  "base_model": "Servicenow Now LLM V6",
  "model_weights_info": "refer to weights and biases project",
  "required_infrastructre": "GPUs needed: 1, GPU Type: A100",
  "training_datasets": [
    "Servicenow Open Incidents"
  ],
  "evaluation_datasets": [
    "Servicenow Open Incidents"
  ],
  "evaluation_metrics_report": "Testing results: See files attached to this record",
  "managed_by": "abel.tuter"
}'
    Der Antworttext zeigt Details zum neu erstellten KI-Modell-Asset, einschließlich der resultierenden sys_ID
    {
  "result": {
    "asset": {
      "sys_id": "a438d170ff96da10c1fbffffffffffd5",
      "display_name": "ServiceNow Now LLM V6",
      "name": "Now LLM",
      "description": "enables text-to-text like question answering and summarization",
      "version": "V8",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Now LLM V5 Documentation",
      "parameters_info": "7B",
      "supported_languages": [
        {
          "sys_id": "914493a30f320010e96b0e4fef767e90",
          "name": "English"
        }
      ],
      "model_size_in_mb": "87",
      "deployment_guideline": "Deployed on ServiceNow infrastructure",
      "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
      "training_procedure": "2",
      "context_window": "8000",
      "state": "Deployed",
      "required_infrastructure": "Servicenow Instance",
      "base_model": {
        "sys_id": "a438d170ff96da10c1fbffffffffffd5",
        "name": "ServiceNow Now LLM V8"
      },
      "evaluation_datasets": [
        {
          "sys_id": "45cb45baff06d610c1fbffffffffffa9",
          "name": "ServiceNow Open Incidents"
        }
      ],
      "training_datasets": [
        {
          "sys_id": "45cb45baff06d610c1fbffffffffffa9",
          "name": "ServiceNow Open Incidents"
        }
      ],
      "evaluation_metrics_report": "Testing results: See files attached to this record",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-03 16:50:53",
      "updated": "2024-12-12 15:56:28"
    },
    "warnings": [
      "Reference record 'French' not found for supported_languages in table sys_language"
    ]
  }
}

    KI-Assets-API – POST /sn_ent/Asset/ai_System

    Erstellt einen neuen KI-System-Asset-Eintrag in den Tabellen „Digitales KI-System-Asset“ [alm_ai_System_Digital_Asset] und „KI-System-Produktmodell“ [cmdb_ai_System_Product_model] gemäß den Details, die Sie im Anforderungstext angeben.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_System

    Standard-URL: /api/sn_ent/Asset/ai_System

    Unterstützte Anforderungsparameter

    Tabelle : 43. Pfadparameter
    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 : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Details, die im KI-System aktualisiert werden sollen.

    Datentyp: Objekt

    { 
  "name": "String", 
  "description": "String", 
  "provider": "String", 
  "version": "String", 
  "state": Number, 
  "documentation": "String", 
  "ai_models": "String", 
  "ai_prompts": "Strings", 
  "evaluation_datasets": [Array], 
  "evaluation_metrics_report": "String", 
  "managed_by": "String" 
}
    object.name Erforderlich. Name für das KI-System-Produktmodell.

    Datentyp: Zeichenfolge
    object.description Beschreibung für das KI-System-Produktmodell.

    Datentyp: Zeichenfolge
    object.provider Erforderlich. SYS_ID- oder Namenwert des Felds „Anbieter“ des Datensatzes der Tabelle „Unternehmen“ [Core_Company].

    Datentyp: Zeichenfolge
    Objekt.Status Status, der auf das KI-System-Asset angewendet werden soll.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.Version Version für KI-System-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.Dokumentation Dokumentation des KI-System-Assets.

    Datentyp: Zeichenfolge

    Standard:
    Object.ai_model Kommagetrennte Liste von Namen oder sys_IDs des Datensatzes des digitalen KI-Modells, wobei jede Zeichenfolge einen Feldwert des KI-Modells eines vorhandenen Datensatzes für digitale KI-Modelle darstellt.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Array von Zeichenfolgen

    "ai_models": [{String", "String"}]

    Standard: Leere Zeichenfolge
    Object.Evaluation_Datasets Kommagetrennte Liste von Namen oder sys_IDs der KI-Datensätze, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], KI-System-Asset [digitales KI-System-Asset alm_ai_System_digital_Asset]

    Datentyp: Array von Zeichenfolgen

    "evaluation_datasets": [{String", "String"}]

    Standard: Leere Zeichenfolge
    Object.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse, die sich im Textfeld des KI-System-Asset-Datensatzes befinden. Zum Beispiel:
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.verwaltet_von SYS_ID oder Name des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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 : 46. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 47. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnisse des neuen KI-System-Assets.

    Datentyp: Objekt

    "result": {
  "asset": Object,
  "warnings": [Array]
}
    Ergebnis.Asset Details zum neu erstellten Eintrag.

    Datentyp: Objekt

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    Ergebnis.Asset.KI_Modelle Liste der KI-Modelle im Datensatz „Digitales KI-System-Asset“.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name Name des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Models.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Prompts Liste der KI-Hinweismeldungen des digitalen KI-Systems-Asset [alm_ai_System_Digital_Asset]-Datensatzes.

    Datentyp: Array

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_prompts.name Name des KI-Prompts.

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Prompts.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation für den zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets Liste der KI-Datensätze, die für die Auswertung des Datensatzes des KI-System-Assets verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], KI-System-Asset [alm_ai_System_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen KI-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_metrics_Report Auswertungsergebnisse des KI-System-Assets.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des KI-System-Assets, das zur Auswertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.asset.name Name des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider Wert des Felds Provider im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: Systemproduktmodell [cmdb_ai_ System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: Systemproduktmodell [cmdb_ai_ System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Version Versionsnummer des zugehörigen Datensatzes des KI-Systemproduktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Warnungen Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel fügt einen neuen Eintrag in die Tabellen „Digitales KI-System-Asset“ und „KI-System-Produktmodell“ ein, wobei die im Anforderungstext enthaltenen Details verwendet werden.

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization", 
  "description": "Incident Summarization Skill", 
  "provider": "servicenow", 
  "documentation": "Sample Documentation", 
  "version": "V2", 
  "state": 31, 
  "ai_models": [ 
    "llm_generic_small", 
    "mixtral-instruct" 
  ], 
  "ai_prompts": [ 
    "LLM Prompt"   
  ], 
  "evaluation_datasets": [ 
    "Base dataset" 
  ], 
  "evaluation_metrics_report": "Sample Report", 
  "managed_by": "abel.tuter" 
}'

    Antworttext.

    { 
  "result": { 
    "asset": { 
      "sys_id": "3b140397435a9210a63d00002fb8f2d7", 
      "display_name": "ServiceNow Incident Summarization V2", 
      "name": "Incident Summarization", 
      "description": "Incident Summarization Skill", 
      "version": "V2", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Sample Documentation", 
      "state": "Deployed", 
      "ai_models": [{  
        "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "llm_generic_small"  
      }, 
      {  
        "sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "mixtral-instruct"  
      }], 
      "ai_prompts": [{  
        "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "LLM Prompt"  
      }], 
      "evaluation_datasets": [{  
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "Base dataset"  
      }], 
      "evaluation_metrics_report": "Sample Report", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-11 18:23:09", 
      "updated": "2024-12-11 18:23:09" 
    }, 
    "warnings": [] 
  } 
}

    KI-Assets-API – PUT /SN_ent/Asset/ai_Dataset/{sys_ID}

    Aktualisiert die Daten eines bestimmten KI-Datensatz-Asset-Datensatzes gemäß den Informationen, die Sie im Anforderungstext angeben.

    Hinweis:
    Geben Sie nur die Parameter-Wert-Paare für die spezifischen Daten an, die Sie aktualisieren möchten. Dieser Endpunkt überschreibt die Daten für alle Parameter, die in der Anforderung gesendet werden.

    Verwenden Sie KI-Assets-API – GET /sn_ent/Asset/ai_Dataset/{sys_ID} Methode zum Abrufen eines vorhandenen KI-Datensatzes mit einer bestimmten ID. Sie können dann diese PUT-Methode verwenden, um Werte im Datensatz mit denselben ID-Informationen zu aktualisieren.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_Dataset/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_Dataset/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 49. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    {Object} 
    {
  "acceptable_usage": "String",
  "base_datasets": [Array],
  "dataset_card": "String"
  "data_type": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String", 
  "name": "String", 
  "provider": "String",
  "state": "String" 
  "source": "String",
  "version": "String"
}
    {Object}.acceptable_usage Der Zweck des Datensatzes oder Modells, z. B. für Schulungen oder Bewertungen.
    Gültige Werte:
    • 1 : Gibt den Schulungszweck an
    • 2 : Gibt einen Bewertungszweck an

    Datentyp: Zeichenfolge (Zahl)
    {Object}.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieses Datensatzes erforderlich sind. Akzeptiert Namen oder sys_IDs von Datensätzen, die in der Tabelle „Digitales KI-Datensatz-Asset“ [alm_ai_Dataset_digital_Asset] vorhanden sind.

    Datentyp: Array

    “base_datasets”: ["String", “String"]
    {Object}.Data_type Typ der im Datensatz vorhandenen Daten. Beispiel: Text, Video, Bild Oder 1,2 .

    Datentyp: Zeichenfolge
    {Object}.Dataset_Card Die Datensatzkarte. Eine Dataset_Card ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es enthält Details wie Datenquellen, Funktionen, beabsichtigte Verwendung und alle bekannten Einschränkungen, um ein ordnungsgemäßes Verständnis und eine ordnungsgemäße Nutzung sicherzustellen.

    Datentyp: Zeichenfolge
    {Object}.description Beschreibung des zugehörigen KI-Datensatz-Produktmodells.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Dokumentation Dokumentation für das Produktmodell des KI-Datensatzes.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Managed_by SYS_ID oder Namenswert des Anwenders im Feld verwaltet von des Datensatzes „KI-Datensatz-Produktmodell“.

    Tabellen: Anwender [sys_user], KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    {Object}.Name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_Dataset_Product_model].

    Datentyp: Zeichenfolge
    {Object}.Provider Erforderlich. SYS_ID- oder Namenwert des Felds „Anbieter“ des Datensatzes der Tabelle „Unternehmen“ [Core_Company].

    Datentyp: Zeichenfolge
    {Object}.Source Details zur Quelle des Datensatzes.
    Gültige Werte:
    • Link zur Quelle des Datensatzes.
    • Details der Quelle in nur-Text.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    {Object}.State Status des KI-Datensatz-Assets.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    {Object}.Version Versionsnummer des zugehörigen Datensatzes für KI-Datensatz-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Header

    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 : 52. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 53. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Details des neu erstellten KI-Datensatz-Assets.

    Datentyp: Objekt

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    Ergebnis.Acceptable_usage Zulässige Nutzung für den Datensatz „KI-Datensatz-Asset“. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Bewertungszwecken.

    Datentyp: Objekt

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    Ergebnis.Acceptable_usage.label Bezeichnung des zulässigen Nutzungswerts anzeigen.

    Datentyp: Zeichenfolge
    Ergebnis.Acceptable_usage.value Der Zweck des Datensatzes oder Modells, z. B. für Schulungen oder Bewertungen.
    Gültige Werte:
    • 1 : Gibt den Schulungszweck an
    • 2 : Gibt einen Bewertungszweck an

    Datentyp: Zeichenfolge (Zahl)
    Result.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_ID eines Basisdatensatzes in der Tabelle „Digitales KI-Datensatz-Asset“ [alm_ai_Dataset_digital_Asset].

    Datentyp: Array

    "base_datasets": ["String", "String"]
    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
  "label": "String",
  "value": "String"
}
    Ergebnis.Data_type.label Die Anzeigebezeichnung für den Datentypwert.

    Datentyp: Zeichenfolge
    Ergebnis.Data_type.value Wert des Datentyps des Datensatz-Assets.

    Datentyp: Zeichenfolge
    Ergebnis.Datensatz_Karte Die Datensatzkarte. Eine Dataset_Card ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es enthält Details wie Datenquellen, Funktionen, beabsichtigte Verwendung und alle bekannten Einschränkungen, um ein ordnungsgemäßes Verständnis und eine ordnungsgemäße Nutzung sicherzustellen.

    Datentyp: Zeichenfolge
    result.description Beschreibung des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Anzeigename Anzeigename des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_Dataset_Product_model].

    Datentyp: Zeichenfolge
    Ergebnis.verwaltet_von Details zum Anwender, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name Name des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Managed_by.sys_ID SYS_ID des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.name Name des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider Anbieter des zugehörigen Datensatzes für KI-Datensatz-Produktmodell.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name Name des Anbieters.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz „KI-Datensatz-Produktmodell“.

    Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_Dataset_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Quelle Details zur Quelle des KI-Datensatz-Assets.
    Gültige Werte:
    • Link zur Quelle des Datensatz-Assets.
    • Details (in nur-Text) der Quelle des Datensatz-Assets. Zum Beispiel der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    Ergebnis.Status Status des KI-Datensatz-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.sys_ID SYS_ID des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Datensatz-Asset-Datensatzes.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Version Versionsnummer des zugehörigen Datensatzes für KI-Datensatz-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge
    Ergebnis.Warnungen Kommagetrennte Liste von Warnmeldungen, die beim Erstellen des Datensatzes vorhanden sind. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Details in einem KI-Datensatz mit einer bestimmten ID aktualisiert werden. Der Anforderungstext enthält die zu aktualisierenden Parameterwerte.

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/9833721b331e92101c9aca989d5c7bf0' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Dataset One", 
  "description": "Description for dataset ", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  “source”: “Source of dataset” 
  "documentation": "document", 
  “dataset_card”: “Dataset Card”, 
  “base_datasets”: [ “Dataset Two”, “Dataset Three”], 
  “data_type”: “1,2”, 
  “acceptable_usage”: “1,2”, 
  "managed_by": "abel.tuter" 
}'

    Antworttext.

    { 
  "result": { 
    "asset": { 
      "sys_id": "da8393eb40d25210f877b00c113d1fc1", 
      "display_name": "ServiceNow Closed Incidents", 
      "name": "Closed Incidents", 
      "description": "Incidents with resolution", 
      "documentation": "Sample Documentation", 
      "source": "incident table on servicenow instance", 
      "dataset_card": "Dataset Card", 
      "state": "Deployed", 
      "version": null, 
      "data_type": { 
        "value": "1", 
        "label": "Text" 
      }, 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "managed_by": { 
        "sys_id": "undefined", 
        "name": "" 
      }, 
      "acceptable_usage": { 
        "value": "1", 
        "label": "Training" 
      }, 
      "base_datasets": [], 
      "created": "2024-12-12 01:23:03", 
      "updated": "2024-12-12 01:23:03" 
    }, 
    "warnings": [] 
       } 
}

    KI-Assets-API – PUT /SN_ent/Asset/ai_prompt/{sys_ID}

    Aktualisiert die Daten eines bestimmten KI-Prompt-Asset-Datensatzes gemäß den Informationen, die Sie im Anforderungstext angeben.

    Siehe auch:
    Hinweis:
    Geben Sie nur die Parameter-Wert-Paare für die spezifischen Daten an, die Sie aktualisieren möchten. Dieser Endpunkt überschreibt die Daten für alle Parameter, die in der Anforderung gesendet werden.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_prompt/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_prompt/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 55. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 57. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Inhalt des zu aktualisierenden KI-Prompt-Assets.

    Datentyp: Objekt

    {
  "ai_model": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String" 
  "name": "String",
  "prompt_info": "String", 
  "provider": "String",
  "state": Number,
  "version": "String"
}
    KI_model Name des sys_ID-Werts des Felds KI-Modell im Datensatz des digitalen KI-Modells.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Beschreibung Beschreibung, die das KI-Prompt-Produktmodell bereitstellt.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Dokumentation Dokumentation des KI-Prompt-Produktmodells.

    Tabelle: KI-Prompt-Produktmodell [cmdb_ai_prompt_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    managed_by Name oder sys_ID des Anwenders, der das Asset verwaltet. Befindet sich im Feld verwaltet von des Asset-Datensatzes.

    Tab;e: Anwender [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Prompt-Produktmodell“ [cmdb_ai_prompt_Product_model].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Prompt_info Prompt-Informationen für KI-Prompt-Asset.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Anbieter Erforderlich. Anbietername oder sys_ID des Unternehmens-Tabellendatensatzes.

    Tabelle: Unternehmen [Core_Company]

    Datentyp: Zeichenfolge
    Status Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel:
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Version Versionsnummer zum Zuweisen des KI-Prompt-Produktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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 : 58. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 59. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis 
    result: {
  "asset": {Object},
  "warnings": [Array]
}
    Ergebnis.Asset Details zum neu erstellten Eintrag.

    Datentyp: Objekt

    "asset": {
  "ai_model": Object,
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "managed_by": Object,
  "name": "String",
  "prompt_info": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    Ergebnis.Asset.KI_model Liste der KI-Modelle im Datensatz der Tabelle „KI-System-Asset“.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_model": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name Name des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.KI_Models.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Details zum Anwender, der das Asset verwaltet.

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.asset.name Name des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.prompt_info Prompt-Informationen des KI-Prompt-Asset-Datensatzes.

    Datentyp: Zeichenfolge
    result.asset.provider Wert des Anbieterfelds im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Version Versionsnummer des zugehörigen Datensatzes des KI-Systemproduktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge
    Ergebnis.Warnung Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel aktualisiert die Daten des KI-Prompt-Assets mit der angegebenen sys_ID gemäß den angegebenen Parameterwerten im Anforderungstext.

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/9833721b331e92101c9aca989d5c7bf0' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password' \
  -d '{
  "name": "Incident Summarization prompt1",
  "description": "Prompt for Incident Summarization",
  "provider": "servicenow",
  "version": "V1",
  "state": 31,
  "documentation": "Docuuu",
  "ai_model": "mixtral-instruct",
  "prompt_info": "Provide incident summary using short_decription, state, worknotes",
  "managed_by": "abel.tuter"
 }'

    Antworttext:

    {
  "result": {
    "asset": {
      "sys_id": "9833721b331e92101c9aca989d5c7bf0",
      "display_name": "ServiceNow Incident Summarization prompt1 V1",
      "name": "Incident Summarization prompt1",
      "description": "Prompt for Incident Summarization",
      "version": "V1",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Docuuu",
      "state": "Deployed",
      "ai_model": {
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
        "name": "mixtral-instruct"
      },
      "prompt_info": "Provide incident summary using short_decription, state, worknotes",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-11 04:23:17",
      "updated": "2024-12-11 04:23:17"
    },
    "warnings": []
  }
}

    KI-Assets-API – PUT /SN_ent/Asset/ai_System/{sys_ID}

    Aktualisiert die Daten eines bestimmten KI-Systemdatensatzes gemäß den Informationen, die Sie im Anforderungstext angeben.

    Hinweis:
    Geben Sie nur die Parameter-Wert-Paare für die spezifischen Daten an, die Sie aktualisieren möchten. Dieser Endpunkt überschreibt die Daten für alle Parameter, die in der Anforderung gesendet werden.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_System/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_System/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 61. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 63. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Details, die im KI-System aktualisiert werden sollen.

    Datentyp: Objekt

    { 
  "name": "String", 
  "description": "String", 
  "provider": "String", 
  "version": "String", 
  "state": Number, 
  "documentation": "String", 
  "ai_models": "String", 
  "ai_prompts": "Strings", 
  "evaluation_datasets": [Array], 
  "evaluation_metrics_report": "String", 
  "managed_by": "String" 
}
    object.name Erforderlich. Name für das KI-System-Produktmodell.

    Datentyp: Zeichenfolge
    object.description Beschreibung für das KI-System-Produktmodell.

    Datentyp: Zeichenfolge
    object.provider Erforderlich. SYS_ID- oder Namenwert des Felds „Anbieter“ des Datensatzes der Tabelle „Unternehmen“ [Core_Company].

    Datentyp: Zeichenfolge
    Objekt.Status Status, der auf das KI-System-Asset angewendet werden soll.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.Version Version für KI-System-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.Dokumentation Dokumentation des KI-System-Assets.

    Datentyp: Zeichenfolge

    Standard:
    Object.ai_model Kommagetrennte Liste von Namen oder sys_IDs des Datensatzes des digitalen KI-Modells, wobei jede Zeichenfolge einen Feldwert des KI-Modells eines vorhandenen Datensatzes für digitale KI-Modelle darstellt.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Array von Zeichenfolgen

    "ai_models": [{String", "String"}]

    Standard: Leere Zeichenfolge
    Object.Evaluation_Datasets Kommagetrennte Liste von Namen oder sys_IDs der KI-Datensätze, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], KI-System-Asset [digitales KI-System-Asset alm_ai_System_digital_Asset]

    Datentyp: Array von Zeichenfolgen

    "evaluation_datasets": [{String", "String"}]

    Standard: Leere Zeichenfolge
    Object.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse, die sich im Textfeld des KI-System-Asset-Datensatzes befinden. Zum Beispiel:
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Objekt.verwaltet_von SYS_ID oder Name des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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 : 64. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 65. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_ID.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnisse des aktualisierten KI-System-Assets.

    Datentyp: Objekt

    "result": {
  "asset": Object,
  "warnings": [Array]
}
    Ergebnis.Asset Details zum neu erstellten Asset.

    Datentyp: Objekt

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    Ergebnis.KI_Modelle Liste der KI-Modelle im Datensatz „Digitales KI-System-Asset“.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Array

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_models.name Name des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.KI_Modelle.sys_ID SYS_ID des Datensatzes des digitalen KI-Systems.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.KI_Prompts Liste der KI-Hinweismeldungen im Datensatz „KI-System-Asset“.

    Datentyp: Array

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_prompts.name Name des KI-Prompts.

    Datentyp: Zeichenfolge
    Ergebnis.KI_Prompts.sys_ID SYS_ID des Datensatzes des digitalen KI-Prompt-Assets.

    Tabelle: Digitales KI-Prompt-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation für den zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets Liste der KI-Datensätze, die für die Auswertung des Datensatzes des KI-System-Assets verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], KI-System-Asset [alm_ai_System_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen KI-Datensatzes.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_metrics_Report Auswertungsergebnisse des KI-System-Assets.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des KI-System-Assets, das zur Auswertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Objekt

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    result.asset.name Name des zugehörigen Datensatzes des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider Wert des Felds Provider im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-System-Produktmodell [cmdb_ai_System_Product_model]

    Datentyp: Objekt

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: Systemproduktmodell [cmdb_ai_ System_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: Systemproduktmodell [cmdb_ai_ System_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-System-Asset-Datensatzes.

    Tabelle: Digitales KI-System-Asset [alm_ai_System_Digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Version Versionsnummer des zugehörigen Datensatzes des KI-Systemproduktmodells. Beispiel: V2 .

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Warnungen Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_ID eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel aktualisiert das KI-System mit Details, die im Anforderungstext aktualisiert werden sollen.

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/3b140397435a9210a63d00002fb8f2d7' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization", 
  "description": "Skill to summarize incident", 
  "provider": "servicenow", 
  "documentation": "Sample Documentation", 
  "version": "V3", 
  "state": 31, 
  "ai_models": [ 
    "llm_generic_small" 
  ], 
  "ai_prompts": [ 
    "LLM Prompt" 
  ], 
  "evaluation_datasets": [ 
    "Base dataset" 
  ], 
  "evaluation_metrics_report": "Sample Report", 
  "managed_by": "abel.tutor" 
}'

    Antworttext zeigt die Ergebnisse des Updates an, das auf die angegebene sys_ID des KI-Systems angewendet wurde

    { 
  "result": { 
    "asset": { 
      "sys_id": "3b140397435a9210a63d00002fb8f2d7", 
      "display_name": "ServiceNow Incident Summarization V2", 
      "name": "Incident Summarization", 
      "description": "Skill to summarize incident", 
      "version": "V3", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Sample Documentation", 
      "state": "Deployed", 
      "ai_models": [{  
       "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "llm_generic_small"  
     }], 
      "ai_prompts": [{  
       "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "LLM Prompt"  
     }], 
      "evaluation_datasets": [{  
       "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "Base dataset"  
     }], 
      "evaluation_metrics_report": "Sample Report", 
      "managed_by": { 
        "sys_id": "a8f98bb0eb32010045e1a5115206fe3a", 
        "name": "Abraham Lincoln" 
      }, 
      "created": "2024-12-11 19:07:13", 
      "updated": "2024-12-11 19:07:42" 
    }, 
    "warnings": [] 
  } 
}

    KI-Assets-API – PUT /SN_ent/Asset/ai_model/{sys_ID}

    Aktualisiert die Daten eines bestimmten KI-Modell-Asset-Datensatzes gemäß den Informationen, die Sie im Anforderungstext angeben.

    Hinweis:
    Geben Sie nur die Parameter-Wert-Paare für bestimmte Daten an, die Sie aktualisieren möchten. Dieser Endpunkt überschreibt die Daten für alle Parameter, die in der Anforderung gesendet werden.

    URL-Format

    Versionierte URL: /api/sn_ent/{api_Version}/Asset/ai_model/{sys_ID}

    Standard-URL: /api/sn_ent/Asset/ai_model/{sys_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 67. Pfadparameter
    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
    sys_id SYS_ID des Assets.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Zeichenfolge
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Details, die im angegebenen KI-Modell aktualisiert werden sollen.

    Datentyp: Objekt

    {
  "base_model": "String",
  "context_window": "String",
  "deployment_guideline": "String",
  "description": "String",
  "documentation": "String",
  "evaluation_datasets": "String",
  "evaluation_metrics_report": "String",
  "managed_by": "String",
  "model_size_in_mb": "String",
  "model_weights_info": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": "String",
  "required_infrastructure": "String",
  "state": Number,
  "supported_languages": "String",
  "training_datasets": "String",
  "training_procedure": "String",
  "version": "String"
}
    Base_model KI-Modell, von dem diese Modellversion abgeleitet wurde.
    Hinweis:
    Gilt nur für Modelle, die innerhalb der Organisation entwickelt wurden.

    Datentyp: Objekt

    {
  "name": "String",
  "sys_id": "String"
 }

    Standard: Leeres Objekt
    base_model.name Name des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Tabelle: Digitales KI-Modell-Asset alm_ai_model_digital_Asset

    Datentyp: Zeichenfolge
    Base_model.sys_ID SYS_ID des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll.

    Tabelle: Digitales KI-Modell-Asset alm_ai_model_digital_Asset

    Datentyp: Zeichenfolge
    Kontext_Fenster Größe der Eingabesequenzen (in anderen Worten die Anzahl der Token), die das Modell verarbeiten kann.

    Datentyp: Ganzzahl

    Standard: 0
    Deployment_Guideline Anweisungen, die für Modelle gelten, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zeichenfolge

    Standard: Leer
    Beschreibung Beschreibung, um das KI-Modell-Produktmodell anzugeben.

    Aktualisiert in Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leer
    Dokumentation Dokumentation des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Eingabeaufforderung – Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge

    Standard: Leer
    Evaluation_Datasets Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen Assets der KI-Eingabeaufforderung, das zur Auswertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], digitales KI-Prompt-Asset [alm_ai_prompt_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  "String",
  "String"
]
    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Datensatzes.
    • SYS_ID des Datensatzes des digitalen KI-Datensatzes.

    Standard: Leere Zeichenfolge
    Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse, die sich im Textfeld des KI-Datensatz-Asset-Datensatzes befinden. Zum Beispiel:
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    Tabelle: KI-Datensatz-Asset [alm_ai_Dataset_digital_Asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    managed_by SYS_ID oder Name des Anwenders im Feld „verwaltet von“ des KI-Datensatz-Asset-Datensatzes.

    Tabelle: Benutzer [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leer
    Model_size_in_mb Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zahl

    Standard: Leer
    Model_Gewichtungen_Info Zusätzliche Modellinformationen, falls verfügbar. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Datentyp: Zeichenfolge

    Standard: Leer
    name Erforderlich. Name des KI-Modell-Produktmodells.

    Aktualisiert in Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Parameters_info Anzahl der Parameter, die dem Modell zugewiesen werden sollen.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Anbieter Erforderlich. SYS_ID oder Namenswert des Felds „Provider“ eines vorhandenen Unternehmens-Tabellendatensatzes [Core_Company]. Weist diesen Anbieter dem neuen KI-Modell zu.

    Datentyp: Zeichenfolge
    Required_Infrastructure Dokumentation des Infrastrukturbedarfs für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die in einer Organisation bereitgestellt werden.

    Datentyp: Zeichenfolge

    Standard: Leer
    Quelle Details zur Quelle der Person oder der Person, die das Modell erstellt hat.
    Gültige Werte:
    • Link zur Quelle des Modells. Beispiel: https://huggingface.co/mistralai/model1 Oder ein Link zu Github.
    • Details der Quelle in nur-Text. Beispiel: Microsoft Azure

    Datentyp: Zeichenfolge

    Standard: Leer oder null
    Status Status, der auf das KI-Modell-Asset angewendet werden soll.
    Gültige Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    supported_languages Kommagetrennte Liste von Sprachen, die vom KI-Modell unterstützt werden.

    Datentyp: Array

    "supported_languages": [
  "String",
  "String"
]
    Gültige Werte:
    • SYS_ID des Datensatzes „Sprache“ [sys_language]
    • Name des Sprachdatensatzes [sys_language]. Beispiel: „Französisch“, „Englisch“

    Standard: Leere Zeichenfolge
    Training_Datasets Verweis auf 1+ zugeordnete Datensätze, die zum Trainieren des Modells verwendet werden. Kommagetrennte Liste von sys_IDs oder Anzeigenamen der Tabelle „KI-Datensatz-Asset“ [alm_ai_Datensatz_digital_Asset]. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Datentyp: Array

    "training_datasets": [
  "String",
  "String"
]

    Standard: Leere Zeichenfolge
    Training_procedure Typ des auf das KI-Modell anzuwendenden Trainings.
    Gültige Werte:
    • 1 : Entscheidungsstrukturen
    • 2 : Tiefenneuronale Netzwerke
    • 3 : Lineare Regression
    • 4 : Logistische Regression
    • 5 : Zufällige Gesamtstruktur
    • 6 : Überwachtes Lernen
    • 7 : Nicht Überwachtes Lernen
    • 8 : Erstärkungslernen
    • 9 : Lernen Übertragen
    • 10 : Semi-Überwachtes Lernen
    • 11 : Feinabstimmung Der Anweisung
    • 12 : Überwachte Feinabstimmung

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird (z. B. „3“ )

    Standard: 1: Entscheidungsstrukturen
    Version Version für KI-Modell-Produktmodell. Beispiel: V2 .

    Datentyp: Zeichenfolge

    Standard: Leer

    Header

    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 : 70. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 71. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnisse der Asset-Erstellung des KI-Modells.

    Datentyp: Objekt

    "result": { 
    "asset": Object, 
    "warnings": [Array], 
 }
    Ergebnis.Asset Details zum erstellten KI-Modell-Asset.

    Datentyp: Objekt

    "asset": {
  "base_model": Object,
  "context_window": String,
  "created": "String",
  "deployment_guideline": String,
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "model_size_in_mb": String,
  "name": "String",
  "parameters_info": "String",
  "provider": Object,
  "required_infrastructure": String,
  "state": "String",
  "source": String, 
  "supported_languages": Array,
  "sys_id": "String",
  "training_datasets": Array,
  "training_procedure": String,
  "updated": "String",
  "version": "String"
}
    Ergebnis.Asset.Base_model Informationen zum Asset des KI-Modells, von dem diese Version abgeleitet wurde.

    Datentyp: Objekt

    "base_model": { 
  "name": "String",
  "sys_id": "String"
}
    result.asset.base_model.name Anzeigename des KI-Modell-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Base_model.sys_ID SYS_ID des KI-Modell-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Kontext_Fenster Größe der Eingabesequenzen, die das Modell verarbeiten kann. Mit anderen Worten: Die Anzahl der Token.

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird. Beispiel: „6000“ .
    Ergebnis.Asset.erstellt Datum und Uhrzeit der Erstellung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    result.asset.deployment_guideline Anweisungen, die für Modelle gelten, die in einer Organisation entwickelt und bereitgestellt wurden.

    Datentyp: Zeichenfolge
    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Anzeigename Anzeigename des KI-Modell-Asset-Datensatzes.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset] (Feld „Display_Name“)

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_Datasets KI-Datensätze, die für die Bewertung des Modells verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden.

    Tabellen: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_Asset], digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Array

    "evaluation_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.evaluation_datasets.name Name des digitalen KI-Datensatzes-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Evaluation_Datasets.sys_ID SYS_ID des digitalen Asset-Datensatzes des KI-Modells.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Evaluation_metrics_Report Verweis auf die Auswertungsergebnisse.
    Mögliche Werte:
    • Details (in nur-Text), die die Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by Anwender, der den Asset-Datensatz des KI-Modells verwaltet.

    Datentyp: Objekt

    " managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.managed_by.name Name des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Managed_by.sys_ID SYS_ID des Anwenders, der den Asset-Datensatz des KI-Modells verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.model_size_in_mb Größe des Modells in MB. Gilt normalerweise für Modelle, die in einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl
    result.asset.name Name des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider Anbieter des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Objekt

    "provider": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name Name des Unternehmensdatensatzes, der dem Anbieter des zugehörigen Datensatzes für das KI-Modell-Produktmodell entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    result.asset.provider.sys_id SYS_ID des Unternehmensdatensatzes, der dem Anbieter des zugehörigen KI-Modell-Produktmodelldatensatzes entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Modell-Produktmodell [cmdb_ai_model_Product_model]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Quelle Details zur Quelle des Assets.
    Gültige Werte:
    • Link zur Quelle des Modells. Beispiel: https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Oder ein Link zu Github.
    • Details der Quelle in nur-Text. Beispiel: Microsoft Azure

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Status Status des KI-Modell-Asset-Datensatzes.
    Mögliche Werte:
    • In Gebrauch
    • Bereitgestellt
    • Stillgelegt
    • Entwicklung
    • Unbekannt
    • N/V

    Datentyp: Zeichenfolge
    result.asset.supported_languages.name Name der unterstützten Sprache.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages.sys_ID SYS_ID der unterstützten Sprache.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.sys_ID SYS_ID des KI-Modell-Asset-Datensatzes

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_Asset]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Training_Datasets Verweis auf 1+ zugeordnete Datensätze, die zum Trainieren des Modells verwendet werden.

    Datentyp: Array

    "training_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    Ergebnis.Asset.Training_procedure Ein numerischer Wert, der den Typ des auf das Modell angewendeten KI-Trainings angibt.
    Mögliche Werte:
    • 1 : Entscheidungsstrukturen
    • 2 : Tiefenneuronale Netzwerke
    • 3 : Lineare Regression
    • 4 : Logistische Regression
    • 5 : Zufällige Gesamtstruktur
    • 6 : Überwachtes Lernen
    • 7 : Nicht Überwachtes Lernen
    • 8 : Erstärkungslernen
    • 9 : Lernen Übertragen
    • 10 : Semi-Überwachtes Lernen
    • 11 : Feinabstimmung Der Anweisung
    • 12 : Überwachte Feinabstimmung

    Datentyp: Zeichenfolge, die durch eine Zahl dargestellt wird
    Ergebnis.Asset.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des KI-Modell-Assets.

    Format: JJJJ-MM-TT HH:mm:ss

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Version Version des zugehörigen Datensatzes des KI-Modells-Produktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_Product_model table]

    Datentyp: Zeichenfolge
    Ergebnis.required_Infrastructure Dokumentation des Infrastrukturbedarfs für die Bereitstellung des Modells. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen.

    Datentyp: Zeichenfolge
    Ergebnis.Asset.Parameter_Info Eigenschaften der Trainingsdaten, die während des Lernprozesses lernen. Beispiel: 7B Oder 30B .

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages Details zu den vom KI-Modell-Asset unterstützten Sprachen.

    Tabelle: Sprache [sys_language]

    Datentyp: Objekt

    "supported_languages": [
 { 
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.supported_languages.name Name der Sprache, die vom Asset unterstützt wird.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Asset.supported_Languages.sys_ID SYS_ID der Sprache, die vom Asset unterstützt wird.

    Tabelle: Sprache [sys_language]

    Datentyp: Zeichenfolge
    Ergebnis.Warnungen Kommagetrennte Liste von Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sysId eines optionalen Parameters ungültig ist.

    Datentyp: Array

    "warnings": ["String"]

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein bestimmtes KI-Asset-Modell mit der PUT-Methode aktualisiert wird.

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_model/9833721b331e92101c9aca989d5c7bf0' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
-d '{ 
    "name": "Now LLM", 
    "description": "enables text-to-text like question answering and summarization", 
    "provider": "servicenow", 
    "documentation": "Now LLM V5 Documentation", 
    "version": "V8", 
    "parameters_info": "7B", 
    "supported_languages": [ 
        "English", 
        "French" 
    ], 
    "model_size_in_mb": "87", 
    "deployment_guideline": "Deployed on ServiceNow infrastructure", 
    "source": "huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1", 
    "training_procedure": "2", 
    "context_window": "8000", 
    "state": "31", 
    "base_model": "Servicenow Now LLM V6", 
    "model_weights_info": "refer to weights and biases project", 
    "required_infrastructre": "GPUs needed: 1, GPU Type: A100", 
    "training_datasets": [ 
        "Servicenow Open Incidents" 
    ], 
    "evaluation_datasets": [ 
        "Servicenow Open Incidents" 
    ], 
    "evaluation_metrics_report": "Testing results: See files attached to this record", 
    "managed_by": "abel.tuter" 
}'

    Antworttext.

     { 
  "result": { 
    "asset": { 
      "sys_id": "a438d170ff96da10c1fbffffffffffd5", 
      "display_name": "ServiceNow Now LLM V6", 
      "name": "Now LLM", 
      "description": "enables text-to-text like question answering and summarization", 
      "version": "V8", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Now LLM V5 Documentation", 
      "parameters_info": "7B", 
      "supported_languages": [ 
        { 
          "sys_id": "914493a30f320010e96b0e4fef767e90", 
          "name": "English" 
        } 
      ], 
      "model_size_in_mb": "87", 
      "deployment_guideline": "Deployed on ServiceNow infrastructure", 
      "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1", 
      "training_procedure": "2", 
      "context_window": "8000", 
      "state": "Deployed", 
      "required_infrastructure": "undefined", 
      "base_model": { 
        "sys_id": "a438d170ff96da10c1fbffffffffffd5", 
        "name": "ServiceNow Now LLM V8" 
      }, 
      "evaluation_datasets": [ 
        { 
          "sys_id": "45cb45baff06d610c1fbffffffffffa9", 
          "name": "ServiceNow Open Incidents" 
        } 
      ], 
      "training_datasets": [ 
        { 
          "sys_id": "45cb45baff06d610c1fbffffffffffa9", 
          "name": "ServiceNow Open Incidents" 
        } 
      ], 
      "evaluation_metrics_report": "Testing results: See files attached to this record", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-03 16:50:53", 
      "updated": "2024-12-12 15:56:28" 
    }, 
    "warnings": [ 
      "Reference record 'French' not found for supported_languages in table sys_language" 
    ] 
  } 
}