KI-Assets-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 63 Minuten Lesedauer
  • KI-Assets Die API stellt Endpunkte zum Abrufen, Aktualisieren und Erstellen mehrerer Arten von KI-Assets bereit, z. B. Systeme, Datensätze, Prompts 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 ist das Plugin „Asset-Klassen“ (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, wird jedoch verwendet 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} AB

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

    URL-Format

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    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 des KI-Datensatz-Assets. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Evaluierungszwecken.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    Ergebnis.Acceptable_usage.value Zahlenwert der zulässigen Nutzung.
    Gültige Werte:
    • 1: Training
    • 2: Bewertung

    Datentyp: Zeichenfolge

    Result.Base_Datasets Kommagetrennte Liste von Basisdatensätzen, 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 Datensatzes für KI-Datensatz-Assets.

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

    Datentyp: Zeichenfolge

    Result.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
      "label": "String",
      "value": "String"
    }
    Result.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 Datenbasis_Karte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es bietet 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 Datensatzes des KI-Datensatz-Assets.

    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.verwaltet_von.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 der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model].

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz der 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. Beispiel: Der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null

    Ergebnis.Status Status des Datensatzes des KI-Datensatz-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Datensatzes des KI-Datensatz-Assets.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des Datensatzes des KI-Datensatz-Assets.

    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} ab

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Modell-Asset“ [alm_ai_model_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Antworttext-Parameter

    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"
    }
    Result.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.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge, dargestellt durch eine Zahl

    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des Datensatzes für KI-Datensatz-Assets.

    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 werden.

    Datentyp: Zeichenfolge

    result.description Beschreibung, die dem KI-Modell-Produktmodell zugewiesen werden soll.

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

    Datentyp: Zeichenfolge

    Ergebnis.Ergebnis.Anzeigename Anzeigename des Asset-Datensatzes.

    Datentyp: Zeichenfolge

    Ergebnis.Dokumentation Dokumentation des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Aufforderung – Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Evaluation_Datengruppen Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen KI-Datensatzes, das für die 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]

    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 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.verwaltet_von.sys_ID SYS_ID des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge

    result.model_size_in_mb Größe des Modells in MB. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl

    result.name Erforderlich. Name des KI-Modellproduktmodells.

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

    Datentyp: Zeichenfolge

    result.provider Anbieter des zugehörigen Datensatzes der 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 der Tabelle „KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model]“.

    Datentyp: Zeichenfolge

    result.provider.name Name des Anbieters.

    Datentyp: Zeichenfolge

    Ergebnis.required_Infrastructure Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation bereitgestellt werden.

    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:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.supported_Languages 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.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} ab

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

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Aufforderungs-Asset“ [alm_ai_prompt_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 17. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    Name Beschreibung
    Ergebnis Details zum KI-Aufforderungs-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_Modell KI-Modell des Datensatzes der KI-Aufforderung.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    Ergebnis.ai_model.sys_ID SYS_ID des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Aufforderung – Produktmodell [alm_ai_model_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.erstellt Datum und Uhrzeit der Erstellung des Datensatzes für KI-Aufforderungsressourcen.

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

    Datentyp: Zeichenfolge

    result.description Beschreibung des Datensatzes des KI-Prompt-Produktmodells.

    Tabelle: KI-Aufforderung – Produktmodell [cmdb_ai_prompt_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Anzeigename Anzeigename des zugeordneten KI-Aufforderungs-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-Aufforderung – 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.

    Datentyp: Zeichenfolge

    Ergebnis.verwaltet_von.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-Aufforderung – Produktmodell [cmdb_ai_prompt_product_model]

    Datentyp: Zeichenfolge

    result.prompt_info Prompt-Informationen des Datensatzes des KI-Prompt-Assets.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_asset]

    Datentyp: Zeichenfolge

    result.provider Anbieter des Datensatzes des KI-Prompt-Produktmodells.
    "provider": {
      "name": "String",
      "sys_id": "String"
    }

    Datentyp: Objekt

    result.provider.name Name des zugehörigen Datensatzes des KI-Prompt-Produktmodells.

    Datentyp: Zeichenfolge

    result.provider.sys_id SYS_ID des Tabellendatensatzes „Unternehmen“ [Core_Company], der dem Anbieter des zugehörigen Datensatzes für KI-Prompt-Produktmodell entspricht.

    Tabellen: Unternehmen [Core_Company], KI-Aufforderungsproduktmodell [cmdb_ai_prompt_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Status Status des Datensatzes des KI-Prompt-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Datensatzes der KI-Aufforderung.

    Tabelle: KI-Aufforderungs-Asset [alm_ai_prompt_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des Datensatzes des KI-Aufforderungselements.

    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 Asset-Modell für KI-Aufforderungen 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} ab

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „Digitales KI-System-Asset“ [alm_ai_system_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 23. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    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 der 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.ai_Prompts Liste der KI-Prompts 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.ai_Prompts.sys_ID SYS_ID des Datensatzes des digitalen Assets der KI-Aufforderung.

    Tabelle: KI-Aufforderung – digitales 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Anzeigename Anzeigename des Datensatzes der KI-Systemanlage.

    Tabelle: KI-System-Asset [cmdb_ai_ System_Asset_model]

    Datentyp: Zeichenfolge

    Ergebnis.Dokumentation Dokumentation für den Datensatz des KI-Systemproduktsystems.

    Tabelle: KI-System-Produktsystem [cmdb_ai_system_product_system]

    Datentyp: Zeichenfolge

    Ergebnis.Evaluation_Datengruppen Liste der KI-Datensätze, die für die Auswertung des Modells im Datensatz für digitale KI-Systeme 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.

    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 Ergebnisse umreißen
    • Links zu bestimmten Ergebnissen

    Datentyp: Zeichenfolge

    Ergebnis.verwaltet_von Details zum Anwender, der den Datensatz für KI-Systemressourcen verwaltet.

    Datentyp: Objekt

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

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge

    Ergebnis.verwaltet_von.sys_ID Name des Anwenders, der den Datensatz des KI-System-Assets verwaltet.

    Tabelle: Anwender [Anwender]

    Datentyp: Zeichenfolge

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

    Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    result.provider Wert des Felds „Anbieter“ im zugehörigen Datensatz des KI-Systemproduktmodells.

    Tabelle: KI-Systemproduktmodell [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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

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

    Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Status Status des Datensatzes des KI-System-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Tabelle: Digitales KI-System-Asset [alm_ai_system_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Datensatzes für KI-Systemressourcen.

    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_Datengruppe

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstext-Parameter (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": "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 Bestimmt, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Evaluierungszwecken.
    Gültige Werte:
    • 1: Training
    • 2: Bewertung

    Datentyp: Zeichenfolge

    {Object}.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieser Datengruppe 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}.Datengruppe_Card Die Datensatzkarte. Eine Datenbasis_Karte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es bietet 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 zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model].

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    {Object}.Managed_by Wert des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].
    Gültige Werte:
    • Name des Anwenderdatensatzes [sys_user]
    • SYS_ID des Anwenderdatensatzes [sys_user]

    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. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [Core_Company].
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    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:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 29. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    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 des KI-Datensatz-Assets. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Evaluierungszwecken.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    Ergebnis.Acceptable_usage.value Zahlenwert der zulässigen Nutzung.
    Gültige Werte:
    • 1: Training
    • 2: Bewertung

    Datentyp: Zeichenfolge

    Result.Base_Datasets Kommagetrennte Liste von Basisdatensätzen, 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 Datensatzes für KI-Datensatz-Assets.

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

    Datentyp: Zeichenfolge

    Result.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
      "label": "String",
      "value": "String"
    }
    Result.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 Datenbasis_Karte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es bietet 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 Datensatzes des KI-Datensatz-Assets.

    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.verwaltet_von.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 der 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 der Tabelle „KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model]“.

    Datentyp: Zeichenfolge

    result.provider.name Name des Anbieters.

    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. Beispiel: Der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null

    Ergebnis.Status Status des Datensatzes des KI-Datensatz-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Datensatzes des KI-Datensatz-Assets.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des Datensatzes des KI-Datensatz-Assets.

    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 ein neuer Datensatz für KI-Datensatz-Assets erstellt wird.

    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-Aufforderung“ [alm_ai_prompt_digital_asset] und „Produktmodell der KI-Aufforderung“ [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. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge

    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Inhalt des zu aktualisierenden KI-Aufforderungs-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 Wert des Felds „KI-Modell“ eines vorhandenen Datensatzes in der Tabelle „Digitales KI-Modell“ [alm_ai_model_digital_asset].
    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Modells [alm_ai_model_digital_asset]
    • SYS_ID des Datensatzes des digitalen KI-Modells [alm_ai_model_digital_asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Beschreibung Beschreibung, die dem KI-Prompt-Produktmodell bereitgestellt werden soll.

    Tabelle: KI-Aufforderung – Produktmodell [cmdb_ai_prompt_product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Dokumentation Dokumentation des KI-Prompt-Produktmodells.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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

    name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Aufforderungsproduktmodell“ [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. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [Core_Company].
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Staat Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel:
    Gültige Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Header

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

    Tabelle : 34. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 35. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    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.ai_model Liste der KI-Modelle im Datensatz der Tabelle „KI-Systeminventar“ [cmdb_ai_ System_Asset_model].

    Datentyp: Array

    "ai_model": [
      {
      "name": "String",
      "sys_id": "String"
      }
    ]
    result.asset.ai_models.name Name des Datensatzes der Tabelle „Digitales KI-System-Asset [alm_ai_system_digital_asset]“.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.ai_model.sys_ID SYS_ID des Datensatzes der Tabelle „Digitales KI-System-Asset [alm_ai_system_digital_asset]“.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.ai_Prompts Liste der KI-Prompts des Datensatzes für KI-Systemressourcen.

    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.ai_Prompts.sys_ID SYS_ID des Datensatzes der 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes der KI-Systemanlage.

    Tabelle: Digitales KI-System-Asset [alm_ai_system_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Systemproduktmodell“ [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.

    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 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    result.asset.provider Wert des Felds „Anbieter“ im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Objekt

    provider: {
      "name": "String",
      "sys_id": "String"
    }
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.Asset.sys_ID SYS_ID des Datensatzes für KI-Systemressourcen.

    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 Asset-Eintrag für KI-Modell in den Tabellen „Digitales Asset für KI-Modell“ [alm_ai_model_digital_asset] und „Produktmodell für KI-Modelle [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. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge

    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Anforderungstext-Parameter (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 werden.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    {Object}.description Beschreibung, die dem KI-Modell-Produktmodell zugewiesen werden soll.

    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_Datengruppen 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 Bewertungsergebnisse, 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 Asset des KI-Modells [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 innerhalb einer Organisation entwickelt und bereitgestellt werden.

    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-Modellproduktmodells.

    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. Wert des Felds „Anbieter“ des vorhandenen Datensatzes in der Tabelle „Unternehmen“ [Core_Company]. Weist diesen Anbieter dem neuen KI-Modell zu.
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    {Object}.required_Infrastructure Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation bereitgestellt werden.

    Datentyp: Zeichenfolge

    Standard: Leer oder null

    {Object}.Source Details zur Quelle, wer oder was 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:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 der Sprache [sys_language]
    • Name des Datensatzes der Sprache [sys_language]. Beispiel: „Französisch“, „Englisch“ .

    Standard: Leere Zeichenfolge

    {Object}.Training_Datengruppen Datensätze, die zum Trainieren des KI-Modells verwendet werden. Kommagetrennte Liste von sys_IDs oder Anzeigenamen der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_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 Typ des auf das KI-Modell anzuwendenden Trainings.
    Gültige 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, 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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 40. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 41. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    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 KI-Modell-Asset, 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, dargestellt durch eine Zahl. 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 werden.

    Datentyp: Zeichenfolge

    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes des KI-Modells-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset] (Display_Name-Feld)

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen Assets des KI-Modells, das für die 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-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.

    Datentyp: Zeichenfolge

    Ergebnis.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen 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 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

    result.asset.model_size_in_mb Größe des Modells in MB. Normalerweise anwendbar für Modelle, die innerhalb einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl

    result.asset.name Name des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    result.asset.provider Anbieter des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Datensatzes aus der Tabelle „Unternehmen“ [Core_Company], der dem Anbieter des zugehörigen Datensatzes des KI-Modellproduktmodells entspricht.

    Tabelle: 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 Datensatzes des KI-Modells-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Datensatzes des KI-Modells-Assets

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Training_Datengruppen 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 Typ des auf das Modell angewendeten KI-Trainings.
    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.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-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model-Tabelle]

    Datentyp: Zeichenfolge

    Ergebnis.required_Infrastructure Dokumentation der Infrastrukturanforderungen 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 Sprachen, die vom KI-Modell-Asset unterstützt werden.

    Tabelle: Sprache [sys_language]

    Datentyp: Objekt

    "supported_languages": [
     { 
      "name": "String",
      "sys_id": "String"
      }
    ]
    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 erstellt ein KI-Modell-Asset gemäß den Details im Anforderungstext.

    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 an, 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-Systemproduktmodell“ [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. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge

    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstext-Parameter (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. Wert des Felds „Anbieter“ in einem vorhandenen Tabellendatensatz „Unternehmen [Core_Company]“.
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Objekt.Status Status, der auf das KI-System-Asset angewendet werden soll.
    Gültige Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Zeichenfolgen, wobei jede Zeichenfolge einen Feldwert für das KI-Modell eines vorhandenen Datensatzes für digitale KI-Modelle darstellt.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset]

    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Modells.
    • SYS_ID des Datensatzes des digitalen KI-Modells.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Object.Evaluation_Datengruppen Kommagetrennte Liste von KI-Datensätzen, die für die Auswertung des Datensatzes für KI-Systemressourcen 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 [KI-System-Digital Asset alm_ai_system_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 Bewertungsergebnisse, 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

    Object.Managed_by Wert des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].
    Gültige Werte:
    • Name des Anwenderdatensatzes [sys_user]
    • SYS_ID des Anwenderdatensatzes [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Header

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

    Tabelle : 46. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 47. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    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.ai_Models Liste der KI-Modelle im Datensatz „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 der Tabelle „Digitales KI-System-Asset [alm_ai_system_digital_asset]“.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.ai_model.sys_ID SYS_ID des Datensatzes der Tabelle „Digitales KI-System-Asset [alm_ai_system_digital_asset]“.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.ai_Prompts Liste der KI-Prompts des Datensatzes für digitale KI-Systeme [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.ai_Prompts.sys_ID SYS_ID des Datensatzes der 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes der KI-Systemanlage.

    Tabelle: Digitales KI-System-Asset [alm_ai_system_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets Liste der KI-Datensätze, die für die Auswertung des Datensatzes der KI-Systemressourcen 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.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes der 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 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 für die 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    result.asset.provider Wert des Felds „Anbieter“ im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Objekt

    provider: {
      "name": "String",
      "sys_id": "String"
    }
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.Asset.sys_ID SYS_ID des Datensatzes für KI-Systemressourcen.

    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 Details im Anforderungstext 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} ABMethode 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_Datengruppe/{sys_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Anforderungstext-Parameter (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 Bestimmt, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Evaluierungszwecken.
    Gültige Werte:
    • 1: Training
    • 2: Bewertung

    Datentyp: Zeichenfolge

    {Object}.Base_Datasets Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieser Datengruppe 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}.Datengruppe_Card Die Datensatzkarte. Eine Datenbasis_Karte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es bietet 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 zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model].

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    {Object}.Managed_by Wert des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].
    Gültige Werte:
    • Name des Anwenderdatensatzes [sys_user]
    • SYS_ID des Anwenderdatensatzes [sys_user]

    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. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [Core_Company].
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    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:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 52. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 53. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    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 des KI-Datensatz-Assets. Die zulässige Nutzung bezieht sich darauf, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise zu Schulungs- oder Evaluierungszwecken.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    Ergebnis.Acceptable_usage.value Zahlenwert der zulässigen Nutzung.
    Gültige Werte:
    • 1: Training
    • 2: Bewertung

    Datentyp: Zeichenfolge

    Result.Base_Datasets Kommagetrennte Liste von Basisdatensätzen, 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 Datensatzes für KI-Datensatz-Assets.

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

    Datentyp: Zeichenfolge

    Result.Data_type Der Typ der Daten, die im Datensatz des KI-Datensatz-Assets vorhanden sind.

    Datentyp: Objekt

    "data_type": {
      "label": "String",
      "value": "String"
    }
    Result.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 Datenbasis_Karte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es bietet 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 Datensatzes des KI-Datensatz-Assets.

    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.verwaltet_von.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 der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model].

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    result.provider.sys_id SYS_ID des Anbieters im zugehörigen Datensatz der 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. Beispiel: Der Name eines Produkts oder einer Website.

    Datentyp: Zeichenfolge

    Standard: Leer oder null

    Ergebnis.Status Status des Datensatzes des KI-Datensatz-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID des Datensatzes des KI-Datensatz-Assets.

    Tabelle: Digitales KI-Datensatz-Asset [alm_ai_dataset_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.aktualisiert Datum und Uhrzeit der letzten Aktualisierung des Datensatzes des KI-Datensatz-Assets.

    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.

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Aufforderungs-Asset“ [alm_ai_prompt_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 57. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Objekt Erforderlich. Inhalt des zu aktualisierenden KI-Aufforderungs-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 Wert des Felds „KI-Modell“ eines vorhandenen Datensatzes in der Tabelle „Digitales KI-Modell“ [alm_ai_model_digital_asset].
    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Modells [alm_ai_model_digital_asset]
    • SYS_ID des Datensatzes des digitalen KI-Modells [alm_ai_model_digital_asset]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Beschreibung Beschreibung, die dem KI-Prompt-Produktmodell bereitgestellt werden soll.

    Tabelle: KI-Aufforderung – Produktmodell [cmdb_ai_prompt_product_model]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Dokumentation Dokumentation des KI-Prompt-Produktmodells.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    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

    name Erforderlich. Name des zugeordneten Datensatzes in der Tabelle „KI-Aufforderungsproduktmodell“ [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. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [Core_Company].
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Staat Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel:
    Gültige Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Header

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

    Tabelle : 58. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 59. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    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.ai_model Liste der KI-Modelle im Datensatz der Tabelle „KI-Systeminventar“ [cmdb_ai_ System_Asset_model].

    Datentyp: Array

    "ai_model": [
      {
      "name": "String",
      "sys_id": "String"
      }
    ]
    result.asset.ai_models.name Name des Datensatzes der Tabelle „Digitales KI-System-Asset [alm_ai_system_digital_asset]“.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.ai_model.sys_ID SYS_ID des Datensatzes der 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes der KI-Systemanlage.

    Tabelle: Digitales KI-System-Asset [alm_ai_system_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Systemproduktmodell“ [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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    result.asset.prompt_info Prompt-Informationen des Datensatzes des KI-Prompt-Assets.

    Datentyp: Zeichenfolge

    result.asset.provider Wert des Felds „Anbieter“ im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Objekt

    provider: {
      "name": "String",
      "sys_id": "String"
    }
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.Asset.sys_ID SYS_ID des Datensatzes für KI-Systemressourcen.

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „Digitales KI-System-Asset“ [alm_ai_system_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 63. Anforderungstext-Parameter (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. Wert des Felds „Anbieter“ in einem vorhandenen Tabellendatensatz „Unternehmen [Core_Company]“.
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Objekt.Status Status, der auf das KI-System-Asset angewendet werden soll.
    Gültige Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Zeichenfolgen, wobei jede Zeichenfolge einen Feldwert für das KI-Modell eines vorhandenen Datensatzes für digitale KI-Modelle darstellt.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset]

    Gültige Werte:
    • Name des Datensatzes des digitalen KI-Modells.
    • SYS_ID des Datensatzes des digitalen KI-Modells.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Object.Evaluation_Datengruppen Kommagetrennte Liste von KI-Datensätzen, die für die Auswertung des Datensatzes für KI-Systemressourcen 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 [KI-System-Digital Asset alm_ai_system_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 Bewertungsergebnisse, 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

    Object.Managed_by Wert des Felds „verwaltet von“ eines vorhandenen Anwendertabellendatensatzes [sys_user].
    Gültige Werte:
    • Name des Anwenderdatensatzes [sys_user]
    • SYS_ID des Anwenderdatensatzes [sys_user]

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Header

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

    Tabelle : 64. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 65. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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. Die Antwort enthält zusätzliche 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 der 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.ai_Prompts Liste der KI-Prompts 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.ai_Prompts.sys_ID SYS_ID des Datensatzes des digitalen Assets der KI-Aufforderung.

    Tabelle: KI-Aufforderung – digitales 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes der KI-Systemanlage.

    Tabelle: Digitales KI-System-Asset [alm_ai_system_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets Liste der KI-Datensätze, die für die Auswertung des Datensatzes der KI-Systemressourcen 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.

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes der 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 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 für die 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-Systemproduktmodell [cmdb_ai_system_product_model]

    Datentyp: Zeichenfolge

    result.asset.provider Wert des Felds „Anbieter“ im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Objekt

    provider: {
      "name": "String",
      "sys_id": "String"
    }
    result.asset.provider.name Name des Anbieters im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Anbieters im zugehörigen Tabellendatensatz des KI-Systemproduktmodells [cmdb_ai_ System_Product_model].

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Status Status des KI-Modell-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: N/V

    Datentyp: Zeichenfolge

    Ergebnis.Asset.sys_ID SYS_ID des Datensatzes für KI-Systemressourcen.

    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" 
    }'

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

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Assets in der Tabelle „KI-Aufforderungs-Asset“ [alm_ai_prompt_digital_asset].

    Datentyp: Zeichenfolge

    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstext-Parameter (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.

    Datentyp: Zeichenfolge

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

    Tabelle: alm_ai_model_digital_asset für digitale Assets des KI-Modells

    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 werden.

    Datentyp: Zeichenfolge

    Standard: Leer

    Beschreibung Beschreibung, die dem KI-Modell-Produktmodell zugewiesen werden soll.

    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-Aufforderung – Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Standard: Leer

    Evaluation_Datengruppen Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen Assets der KI-Aufforderung, das für die 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-Aufforderungs-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 Bewertungsergebnisse, die sich im Textfeld des Datensatzes des KI-Datensatz-Assets 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 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: Leer

    model_size_in_mb Größe des Modells in MB. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl

    Standard: Leer

    Model_weight_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-Modellproduktmodells.

    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. Wert des Felds „Anbieter“ eines vorhandenen Tabellendatensatzes für Unternehmen [Core_Company]. Weist diesen Anbieter dem neuen KI-Modell zu.
    Gültige Werte:
    • Name des Unternehmens [Core_Company]-Datensatzes
    • SYS_ID des Unternehmens [Core_Company]-Datensatzes

    Datentyp: Zeichenfolge

    Required_Infrastructure Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Beispiel: Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation bereitgestellt werden.

    Datentyp: Zeichenfolge

    Standard: Leer

    Quelle Details zur Quelle, wer oder was 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

    Staat Status, der auf das KI-Modell-Asset angewendet werden soll.
    Gültige Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Sprachdatensatzes [sys_language]
    • Name des Datensatzes der Sprache [sys_language]. Beispiel: „Französisch“, „Englisch“

    Standard: Leere Zeichenfolge

    Training_Datengruppen 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_dataset_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: 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, 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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

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

    Standard: application/json

    Tabelle : 71. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 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 KI-Modell-Asset, 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, dargestellt durch eine Zahl. 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 werden.

    Datentyp: Zeichenfolge

    result.asset.description Beschreibung des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Anzeigename Anzeigename des Datensatzes des KI-Modells-Assets.

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset] (Display_Name-Feld)

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Dokumentation Dokumentation des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Evaluation_Datasets Kommagetrennte Liste von sys_IDs oder Anzeigenamen von KI-Datensätzen des digitalen Assets des KI-Modells, das für die 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-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.

    Datentyp: Zeichenfolge

    Ergebnis.Evaluation_Datasets.sys_ID SYS_ID des Datensatzes des digitalen 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 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

    result.asset.model_size_in_mb Größe des Modells in MB. Normalerweise anwendbar für Modelle, die innerhalb einer Organisation entwickelt und bereitgestellt werden.

    Datentyp: Zahl

    result.asset.name Name des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Zeichenfolge

    result.asset.provider Anbieter des zugehörigen Datensatzes des KI-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model]

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    result.asset.provider.sys_id SYS_ID des Datensatzes aus der Tabelle „Unternehmen“ [Core_Company], der dem Anbieter des zugehörigen Datensatzes des KI-Modellproduktmodells entspricht.

    Tabelle: 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 Datensatzes des KI-Modells-Assets.
    Mögliche Werte:
    • 1: In Gebrauch
    • 31: Bereitgestellt
    • 32: Stillgelegt
    • 33: Entwicklung
    • 34: Unbekannt
    • 35: 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 Datensatzes des KI-Modells-Assets

    Tabelle: Digitales KI-Modell-Asset [alm_ai_model_digital_asset]

    Datentyp: Zeichenfolge

    Ergebnis.Asset.Training_Datengruppen 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 Typ des auf das Modell angewendeten KI-Trainings.
    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.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-Modellproduktmodells.

    Tabelle: KI-Modell-Produktmodell [cmdb_ai_model_product_model-Tabelle]

    Datentyp: Zeichenfolge

    Ergebnis.required_Infrastructure Dokumentation der Infrastrukturanforderungen 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 Sprachen, die vom KI-Modell-Asset unterstützt werden.

    Tabelle: Sprache [sys_language]

    Datentyp: Objekt

    "supported_languages": [
     { 
      "name": "String",
      "sys_id": "String"
      }
    ]
    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 mithilfe 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" 
        ] 
      } 
    }