KI-Assets-API
Die KI-Assets -API bietet Endpunkte zum Abrufen, Aktualisieren und Erstellen verschiedener Arten von KI-Assets, z. B. Systeme, Datensätze, Eingabeaufforderungen und Modelle.
KI-Assets-API – GET /sn_ent/asset/ai_dataset/{sys_id}
Ruft die Daten des angegebenen KI-Datensatz-Assets ab.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_dataset/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_Digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Details des neu erstellten KI-Datensatz-Assets. Datentyp: Objekt |
| result.acceptable_usage | Zulässige Verwendung 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 |
| result.acceptable_usage.label | Bezeichnung des zulässigen Nutzungswerts anzeigen. Datentyp: Zeichenfolge |
| result.acceptable_usage.value | Zahlenwert der zulässigen Nutzung. Gültige Werte:
Datentyp: Zeichenfolge |
| result.base_datasets | Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_id eines Basisdatensatzes in der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset]. Datentyp: Array |
| result.created | Datum und Uhrzeit der Erstellung des Datensatzes des 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 |
| result.data_type.label | Die Anzeigebezeichnung für den Datentypwert. Datentyp: Zeichenfolge |
| result.data_type.value | Wert des Datentyps des Datensatz-Assets. Datentyp: Zeichenfolge |
| result.dataset_card | Die Datensatzkarte. Eine Datensatzkarte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es stellt Detailinformationen wie Datenquellen, Funktionen, beabsichtigte Verwendung und bekannte Einschränkungen bereit, um ein ordnungsgemäßes Verständnis und ordnungsgemäße Verwendung zu gewährleisten. Datentyp: Zeichenfolge |
| result.description | Beschreibung des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model] Datentyp: Zeichenfolge |
| result.display_name | Anzeigename des Asset-Datensatzes „KI-Datensatz“. Tabelle: KI-Datensatz Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Zeichenfolge |
| result.documentation | Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model]. Datentyp: Zeichenfolge |
| result.managed_by | Details zum Benutzer, der den Datensatz des KI-Datensatz-Assets verwaltet. Datentyp: Objekt |
| result.managed_by.name | Name des Benutzers, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Sys_id des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Name | Name des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. 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 |
| Ergebnis.Anbieter.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 |
| result.source | Details zur Quelle des KI-Datensatz-Assets. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| result.state | Status des KI-Datensatz-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des KI-Datensatz-Asset-Datensatzes. Tabelle: KI-Datensatz Digitales 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 des KI-Datensatz-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
cURL-Anforderung
Folgendes Beispiel.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/ cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Ausgabe:
{
"result": {
"sys_id": "9d60fb5f40d21210f877b00c113d1fea",
"display_name": "ServiceNow Closed Incidents v1",
"name": "Closed Incidents",
"description": "Incidents with resolution",
"documentation": "Sample Documentation",
"source": "incident table on servicenow instance",
"dataset_card": "Sample Dataset Card",
"state": "Development",
"version": "v1",
"data_type": {
"value": "2",
"label": "Image"
},
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"acceptable_usage": {
"value": "1",
"label": "Training"
},
"base_datasets": [],
"created": "2024-12-11 08:50:40",
"updated": "2024-12-11 08:50:40"
}
}
KI-Assets-API – GET /sn_ent/asset/ai_model/{sys_id}
Ruft die Daten des angegebenen KI-Modell-Assets ab.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_model/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „KI-Modell-Asset“ [alm_ai_model_Digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Ergebnis | Details des Modell-Asset-Datensatzes. Datentyp: Objekt |
| result.base_model | KI-Modell, von dem diese Modellversion abgeleitet wurde. Hinweis: Gilt nur für Modelle, die innerhalb der Organisation entwickelt wurden. Datentyp: Objekt Standard: |
| result.base_model.name | Name des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll. Datentyp: Zeichenfolge |
| result.base_model.sys_id | Sys_id des KI-Modell-Assets, nach dem dieses KI-Modell modelliert werden soll. Datentyp: Zeichenfolge |
| result.context_window | Größe der Eingabesequenzen (mit anderen Worten: Anzahl der Token), die das Modell verarbeiten kann. Datentyp: Zeichenfolge, dargestellt durch eine Zahl |
| result.created | Datum und Uhrzeit der Erstellung des Datensatzes des 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 für das KI-Modell-Produktmodell. Aktualisiert in Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.result.display_name | Anzeigename des Asset-Datensatzes. Datentyp: Zeichenfolge |
| result.documentation | Dokumentation des Datensatzes „Produktmodell der KI-Aufforderung“. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.evaluation_datasets | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des digitalen Assets „KI-Datensatz“, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Array |
| result.evaluation_metrics_report | Verweis auf die Auswertungsergebnisse. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.managed_by | Details zum Anwender, der den Datensatz des KI-Modell-Assets verwaltet. Datentyp: Objekt |
| result.managed_by.name | Name des Benutzers, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Sys_id des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.model_size_in_mb | Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in 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 |
| 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.Anbieter.Name | Name des Anbieters Datentyp: Zeichenfolge |
| result.required_infrastructure | Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Zum Beispiel Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation bereitgestellt werden. Datentyp: Zeichenfolge |
| result.source | Details zur Quelle des Modells. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.state | Status, der auf das KI-Modell-Asset angewendet werden soll. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.supported_languages | Sprachen, die vom KI-Modell unterstützt werden. Datentyp: Array |
| result.supported_languages.name | Name des Sprachdatensatzes. Beispiel: „Französisch“, „Englisch“.Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.supported_languages.sys_id | Sys_id des Sprachdatensatzes. Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des Asset-Datensatzes des KI-Modells. Tabelle: KI-Modell-Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| Ergebnis.Version | Version des KI-Modellproduktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
cURL-Anforderung
Folgendes Beispiel.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_model/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Ausgabe:
{
"result": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"display_name": "ServiceNow Now LLM V6",
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"version": "V6",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Now LLM V5 Documentation",
"parameters_info": "7B",
"supported_languages": [
{
"sys_id": "914493a30f320010e96b0e4fef767e90",
"name": "English"
}
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": null,
"training_procedure": "2",
"context_window": "8000",
"state": "Deployed",
"required_infrastructure": "undefined",
"base_model": {
"sys_id": null,
"name": ""
},
"evaluation_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"training_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-03 16:50:53",
"updated": "2024-12-03 16:50:53"
}
}
KI-Assets-API – GET /sn_ent/asset/ai_prompt/{sys_id}
Ruft die Daten des angegebenen Assets der KI-Aufforderung ab.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_prompt/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „Asset für KI-Aufforderung“ [alm_ai_prompt_digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Details zum Asset „KI-Aufforderung“. |
| result.ai_model | KI-Modell des Asset-Datensatzes „KI-Aufforderung“. Datentyp: Objekt |
| result.ai_model.name | Name des KI-Modells. Datentyp: Zeichenfolge |
| result.ai_model.sys_id | Sys_id des Datensatzes „Produktmodell der KI-Eingabeaufforderung“. Tabelle: Produktmodell der KI-Aufforderung [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.created | Datum und Uhrzeit der Erstellung des Asset-Datensatzes „KI-Aufforderung“. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| result.description | Beschreibung des Datensatzes „Produktmodell der KI-Aufforderung“. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge |
| result.display_name | Anzeigename des zugehörigen Datensatzes des KI-Aufforderungs-Assets. Tabelle: Asset mit KI-Aufforderung [alm_ai_prompt_digital_asset] Datentyp: Zeichenfolge |
| result.documentation | Dokumentation für den Datensatz des Produktmodells für KI-Aufforderungen. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge |
| result.managed_by | Benutzer, der den Datensatz des KI-Aufforderungs-Assets verwaltet. Datentyp: Objekt |
| result.managed_by.name | Name des Benutzers, der den Asset-Datensatz verwaltet. Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Sys_id des Anwenderdatensatzes, der dem „Verwaltet von“-Anwender des Asset-Datensatzes entspricht. Tabellen: Benutzer [sys_user], Asset mit KI-Aufforderung [alm_ai_model_Digital_asset] Datentyp: Zeichenfolge |
| Ergebnis.Name | Name des zugehörigen KI-Aufforderungsproduktmodells. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge |
| result.prompt_info | Aufforderungsinformationen des Asset-Datensatzes „KI-Aufforderung“. Tabelle: Asset mit KI-Aufforderung [alm_ai_prompt_digital_asset] Datentyp: Zeichenfolge |
| result.provider | Anbieter des Datensatzes „Produktmodell für KI-Aufforderung“.Datentyp: Objekt |
| Ergebnis.Anbieter.Name | Name des zugehörigen Datensatzes des KI-Aufforderungsproduktmodells. Datentyp: Zeichenfolge |
| result.provider.sys_id | Sys_id des Tabellendatensatzes „Unternehmen“ [core_company], der dem Anbieter des zugehörigen Datensatzes für das KI-Aufforderungsproduktmodell entspricht. Tabellen: Unternehmen [core_company], KI-Prompt-Produktmodell [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge |
| result.state | Status des Asset-Datensatzes „KI-Aufforderung“. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des Asset-Datensatzes „KI-Aufforderung“. Tabelle: Asset mit KI-Aufforderung [alm_ai_prompt_digital_asset] Datentyp: Zeichenfolge |
| Ergebnis.aktualisiert | Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung des Asset-Datensatzes „KI-Aufforderung“. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Ergebnis.Version | Version des zugehörigen Datensatzes des KI-Aufforderungsproduktmodells. 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 zu dem spezifischen abgerufenen Prompt-Asset-Modell zurück.
{
"result": {
"sys_id": "cc419cb2331e92101c9aca989d5c7b4c",
"display_name": "ServiceNow ServiceNow Incident Summarization Prompt 4 V8",
"name": "ServiceNow Incident Summarization Prompt 4",
"description": "Prompt for Incident Summarization",
"version": "V8",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Documentation",
"state": "Development",
"ai_model": {
"sys_id": "a57d0be6eb1e5210aa82fab8bad0cd18",
"name": "mistral-large"
},
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-09 03:18:46",
"updated": "2024-12-09 04:26:08"
}
}
KI-Assets-API – GET /sn_ent/asset/ai_system/{sys_id}
Ruft die Daten des angegebenen KI-System-Assets ab.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_system/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „Digitales Asset für KI-Systeme“ [alm_ai_system_Digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Details zum abgerufenen KI-System-Asset. |
| result.ai_models | Liste der KI-Modelle im Datensatz der Tabelle „KI-System – Digitales Asset“ [alm_ai_system_Digital_asset]. Datentyp: Array |
| result.ai_models.name | Name des Datensatzes des digitalen Assets des KI-Systems. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.ai_models.sys_id | Sys_id des Datensatzes „Digitales Asset des KI-Systems“. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.ai_prompts | Liste der KI-Hinweismeldungen im Asset-Datensatz des KI-Systems. Datentyp: Array |
| result.ai_prompts.name | Name der KI-Aufforderung. Datentyp: Zeichenfolge |
| result.ai_prompts.sys_id | Sys_id des Datensatzes „Digitales Asset der KI-Aufforderung“. Tabelle: KI-Aufforderung für digitales Asset [alm_ai_prompt_digital_asset] Datentyp: Zeichenfolge |
| result.created | 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 |
| result.display_name | Anzeigename des Asset-Datensatzes des KI-Systems. Tabelle: KI-System-Asset [cmdb_ai_system_asset_model] Datentyp: Zeichenfolge |
| result.documentation | Dokumentation für den Datensatz „KI-Systemproduktsystem“. Tabelle: KI-System Produktsystem [cmdb_ai_system_product_system] Datentyp: Zeichenfolge |
| result.evaluation_datasets | Liste der KI-Datensätze, die für die Bewertung des Modells im Datensatz des digitalen Assets des KI-Systems verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz Digitales Asset [alm_ai_dataset_Digital_asset], KI-System-Asset [alm_ai_system_Digital_asset] Datentyp: Array Standard: leere Zeichenfolge |
| result.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.evaluation_datasets.sys_id | Sys_id des Datensatzes des digitalen Assets des KI-Datensatzes. Tabelle: KI-Datensatz Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Zeichenfolge |
| result.evaluation_metrics_report | Auswertungsergebnisse des KI-System-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.managed_by | Details zum Anwender, der den Asset-Datensatz des KI-Systems verwaltet. Datentyp: Objekt |
| result.managed_by.name | Sys_id des Anwenders, der den Datensatz des KI-System-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Name des Benutzers, der den Datensatz des KI-System-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.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 |
| Ergebnis.Anbieter.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 |
| result.state | Status des Asset-Datensatzes des KI-Systems. Mögliche Werte:
Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 Asset des KI-Systemmodells 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 Asset-Eintrag für den KI-Datensatz im digitalen Asset des KI-Datensatzes [alm_ai_dataset_Digital_asset] und im KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model] gemäß den Details, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsnummer: /api/sn_ent/{api_version}/asset/ai_dataset
Standard-URL: /api/sn_ent/asset/ai_dataset
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| {Objekt} |
|
| {Objekt} |
|
| {object}.acceptable_usage | Bestimmt, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise für Schulungs- oder Evaluierungszwecke. Gültige Werte:
Datentyp: Zeichenfolge |
| {object}.base_datasets | Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieses Datensatzes erforderlich sind. Akzeptiert Namen oder sys_ids von Datensätzen, die in der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset] vorhanden sind. Datentyp: Array |
| {object}.data_type | Typ der im Datensatz vorhandenen Daten. Zum Beispiel Text,Video,Image oder 1,2.Datentyp: Zeichenfolge |
| {object}.dataset_card | Die Datensatzkarte. Eine Datensatzkarte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es stellt Detailinformationen wie Datenquellen, Funktionen, beabsichtigte Verwendung und bekannte Einschränkungen bereit, um ein ordnungsgemäßes Verständnis und ordnungsgemäße Verwendung zu gewährleisten. Datentyp: Zeichenfolge |
| {object}.description | Beschreibung des zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model]. Datentyp: Zeichenfolge |
| {object}.documentation | Dokumentation für das KI-Datensatz-Produktmodell. Datentyp: Zeichenfolge |
| {object}.managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Tabellendatensatzes „Anwender“ [sys_user]. Gültige Werte:
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:
Datentyp: Zeichenfolge |
| {Objekt}.Quelle | Details zur Quelle des Datensatzes. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| {object}.state | Status des KI-Datensatz-Assets. Gültige Werte:
Datentyp: Zeichenfolge |
| {Objekt}.Version | Versionsnummer des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Details des neu erstellten KI-Datensatz-Assets. Datentyp: Objekt |
| result.acceptable_usage | Zulässige Verwendung 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 |
| result.acceptable_usage.label | Bezeichnung des zulässigen Nutzungswerts anzeigen. Datentyp: Zeichenfolge |
| result.acceptable_usage.value | Zahlenwert der zulässigen Nutzung. Gültige Werte:
Datentyp: Zeichenfolge |
| result.base_datasets | Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_id eines Basisdatensatzes in der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset]. Datentyp: Array |
| result.created | Datum und Uhrzeit der Erstellung des Datensatzes des 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 |
| result.data_type.label | Die Anzeigebezeichnung für den Datentypwert. Datentyp: Zeichenfolge |
| result.data_type.value | Wert des Datentyps des Datensatz-Assets. Datentyp: Zeichenfolge |
| result.dataset_card | Die Datensatzkarte. Eine Datensatzkarte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es stellt Detailinformationen wie Datenquellen, Funktionen, beabsichtigte Verwendung und bekannte Einschränkungen bereit, um ein ordnungsgemäßes Verständnis und ordnungsgemäße Verwendung zu gewährleisten. Datentyp: Zeichenfolge |
| result.description | Beschreibung des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model] Datentyp: Zeichenfolge |
| result.display_name | Anzeigename des Asset-Datensatzes „KI-Datensatz“. Tabelle: KI-Datensatz Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Zeichenfolge |
| result.documentation | Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model]. Datentyp: Zeichenfolge |
| result.managed_by | Details zum Benutzer, der den Datensatz des KI-Datensatz-Assets verwaltet. Datentyp: Objekt |
| result.managed_by.name | Name des Benutzers, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Sys_id des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Name | Name des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. 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 |
| 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.Anbieter.Name | Name des Anbieters Datentyp: Zeichenfolge |
| result.source | Details zur Quelle des KI-Datensatz-Assets. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| result.state | Status des KI-Datensatz-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des KI-Datensatz-Asset-Datensatzes. Tabelle: KI-Datensatz Digitales 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 des KI-Datensatz-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
| result.warnings | Kommagetrennte Liste der 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 |
cURL-Anforderung
Das folgende Beispiel zeigt, wie Sie einen neuen Asset-Datensatz für einen KI-Datensatz erstellen.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d ' {
"name": "Dataset One",
"description": "Description for dataset ",
"provider": "servicenow",
"version": "V1",
"state": 31,
“source”: “Source of dataset”
"documentation": "document",
“dataset_card”: “Dataset Card”,
“base_datasets”: [ “Dataset Two”, “Dataset Three”],
“data_type”: “1,2”,
“acceptable_usage”: “1,2”,
"managed_by": "abel.tuter"
}'
Antworttext. Die Ergebnisse des neu erstellten Datensatz-Asset-Datensatzes.
{
"result": {
"asset": {
"sys_id": "da8393eb40d25210f877b00c113d1fc1",
"display_name": "ServiceNow Closed Incidents",
"name": "Closed Incidents",
"description": "Incidents with resolution",
"documentation": "Sample Documentation",
"source": "incident table on servicenow instance",
"dataset_card": "Dataset Card",
"state": "Deployed",
"version": null,
"data_type": {
"value": "1",
"label": "Text"
},
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"managed_by": {
"sys_id": "undefined",
"name": ""
},
"acceptable_usage": {
"value": "1",
"label": "Training"
},
"base_datasets": [],
"created": "2024-12-12 01:23:03",
"updated": "2024-12-12 01:23:03"
},
"warnings": []
}
}
KI-Assets-API – POST /sn_ent/asset/ai_prompt
Erstellt einen neuen Asset-Eintrag für KI-Prompt in den Tabellen „Digitales Asset für KI-Prompt“ [alm_ai_prompt_Digital_asset] und „Produktmodell für KI-Prompt“ [cmdb_ai_promt_product_model] gemäß den Details, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsnummer: /api/sn_ent/{api_version}/asset/ai_prompt
Standard-URL: /api/sn_ent/asset/ai_prompt
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Objekt | Erforderlich. Inhalt des zu aktualisierenden Assets der KI-Aufforderung. Datentyp: Objekt |
| ai_model | Wert des Felds „KI-Modell“ eines vorhandenen Datensatzes in der Tabelle „Digitales Asset des KI-Modells“ [alm_ai_model_Digital_asset]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| description | Beschreibung für das KI-Aufforderungsproduktmodell. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Dokumentation | Dokumentation des Produktmodells für KI-Eingabeaufforderungen. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Datensatzes in der Tabelle „Benutzer“ [sys_user]. Gültige Werte:
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“ | Aufforderungsinformationen für das Asset „KI-Aufforderung“. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Anbieter | Erforderlich. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [core_company]. Gültige Werte:
Datentyp: Zeichenfolge |
| state | Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel: Gültige Werte:
Datentyp: Zeichenfolge |
| version | Versionsnummer zum Zuweisen des KI-Prompt-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse der neuen KI-Asset-Eingabeaufforderung. Datentyp: Objekt |
| result.asset | Details zum neu erstellten Eintrag. Datentyp: Objekt |
| result.asset.ai_model | Liste der KI-Modelle im Datensatz der Tabelle „KI-System-Asset“ [cmdb_ai_system_asset_model]. Datentyp: Array |
| result.asset.ai_models.name | Name des Datensatzes der Tabelle „Digitales Asset des KI-Systems“ [alm_ai_system_digital_asset]. Datentyp: Zeichenfolge |
| result.asset.ai_models.sys_id | Sys_id des Tabellendatensatzes „KI-System – Digitales Asset“ [alm_ai_system_Digital_asset]. Datentyp: Zeichenfolge |
| result.asset.ai_prompts | Liste der KI-Hinweise für den Datensatz des KI-System-Assets. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Array |
| result.asset.ai_prompts.name | Name der KI-Aufforderung. Datentyp: Zeichenfolge |
| result.asset.ai_prompts.sys_id | Sys_id des Tabellendatensatzes „KI-System – Digitales 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 |
| result.asset.evaluation_datasets | Liste der sys_ids oder Anzeigenamen der KI-Datensätze, die zur Bewertung des Asset-Modells des KI-Systems verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz Digitales Asset [alm_ai_dataset_Digital_asset], KI-System – Digitales Asset [alm_ai_system_Digital_asset] Datentyp: Array |
| result.asset.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.asset.evaluation_datasets.sys_id | Sys_id des Datensatzes „Digitales Asset des KI-Systems“. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.asset.evaluation_metrics_report | Bewertungsergebnisse des KI-System-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.managed_by | Details zum Benutzer, der das Asset verwaltet. Datentyp: Objekt |
| result.asset.managed_by.name | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Name | Name des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Wert des Felds „Anbieter“ im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Objekt |
| Ergebnis.Asset.Anbieter.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 Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_id eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Das folgende Beispiel zeigt, wie Sie mit der POST-Methode eine neue KI-Eingabeaufforderung gemäß den im Anforderungstext angegebenen Details 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": []
}
}
API für KI-Assets – POST /sn_ent/asset/ai_model
Erstellt einen neuen KI-Modell-Asset-Eintrag in den Tabellen „KI-Modell | Digitales Asset“ [alm_ai_model_Digital_asset] und „KI-Modell-Produktmodell“ [cmdb_ai_model_product_model] gemäß den Details, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsnummer: /api/sn_ent/{api_version}/asset/ai_model
Standard-URL: /api/sn_ent/asset/ai_model
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| {Objekt} | Erforderlich. Details, die auf den neuen Asset-Modell-Datensatz angewendet werden sollen. Datentyp: Objekt |
| {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 |
| {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: KI-Modell – Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.context_window | Größe der Eingabesequenzen (mit anderen Worten: 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 für das KI-Modell-Produktmodell. Aktualisierte Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.documentation | Dokumentation des KI-Modellproduktmodells. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.evaluation_datasets | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen der für die Bewertung des Modells verwendeten KI-Datensätze. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-Modell-Asset [alm_ai_model_Digital_asset] Datentyp: Array Gültige Werte:
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:Tabelle: KI-Modell für digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Datensatzes in der Tabelle „Anwender“ [sys_user]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.model_size_in_mb | Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in einer Organisation entwickelt und bereitgestellt werden. Datentyp: Zahl Standard: NULL oder leer |
| {Objekt}.Modell_Gewicht_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 wurden. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.provider | Erforderlich. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [core_company]. Weist diesen Anbieter dem neuen KI-Modell zu. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| {object}.required_infrastructure | Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Zum 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 |
| {Objekt}.Quelle | Details zur Quelle dessen, wer oder was das Modell erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| {object}.state | Status, der auf das KI-Modell-Asset angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| {object}.supported_languages | Kommagetrennte Liste der Sprachen, die vom KI-Modell unterstützt werden. Datentyp: Array Gültige Werte:
Standard: leere Zeichenfolge |
| {object}.training_datasets | Datensätze, die zum Trainieren des KI-Modells verwendet werden. Kommagetrennte Liste von sys_ids oder Anzeigenamen der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_Digital_asset]. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Datentyp: Array Standard: leere Zeichenfolge |
| {object}.training_procedure | Typ des Trainings, das auf das KI-Modell angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge, dargestellt durch eine Zahl (z. B. Standard: 1: Entscheidungsstrukturen |
| {Objekt}.Version | Version des KI-Modellproduktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
Parameter des Antworttexts (JSON oder XML)
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse der Asset-Erstellung des KI-Modells. Datentyp: Objekt |
| result.asset | Details zum erstellten KI-Modell-Asset. Datentyp: Objekt |
| result.asset.base_model | Informationen zum Asset des KI-Modells, von dem diese Version abgeleitet wurde. Datentyp: Objekt |
| result.asset.base_model.name | Anzeigename des KI-Modell-Assets. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.base_model.sys_id | Sys_id des KI-Modell-Assets. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.context_window | Größe der Eingabesequenzen, die das Modell verarbeiten kann. Mit anderen Worten: die Anzahl der Token. Datentyp: Zeichenfolge, dargestellt durch eine Zahl. Beispiel: |
| 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des KI-Modell-Asset-Datensatzes. Tabelle: Digitales Asset „KI-Modell“ [alm_ai_model_digital_asset] (Feld „display_name“) Datentyp: Zeichenfolge |
| Ergebnis.Asset.Dokumentation | Dokumentation des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.asset.evaluation_datasets | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des digitalen Assets „KI-Modell“, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Array |
| result.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.evaluation_datasets.sys_id | Sys_id des digitalen Asset-Datensatzes „KI-Modell“. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.evaluation_metrics_report | Verweis auf die Auswertungsergebnisse. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.managed_by | Benutzer, der den Asset-Datensatz des KI-Modells verwaltet. Datentyp: Objekt |
| result.asset.managed_by.name | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.model_size_in_mb | Größe des Modells in MB. Gilt normalerweise für Modelle, die in einer Organisation entwickelt und bereitgestellt werden. Datentyp: Zahl |
| result.asset.name | Name des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Anbieter des zugehörigen KI-Modell-Produktmodelldatensatzes. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Objekt |
| 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 „KI-Modell-Produktmodell“ entspricht. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Quelle | Details zur Quelle des Assets. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.supported_languages.name | Name der unterstützten Sprache. Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.asset.supported_languages.sys_id | Sys_id der unterstützten Sprache. Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Modells Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.training_datasets | Verweis auf mehr als einen zugeordneten Datensatz, der zum Trainieren des Modells verwendet wird. Datentyp: Array |
| result.asset.training_procedure | Typ des auf das Modell angewendeten KI-Trainings. Mögliche Werte:
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 „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model table] Datentyp: Zeichenfolge |
| result.required_infrastructure | Dokumentation der Infrastrukturanforderungen für die Bereitstellung des Modells. Zum Beispiel Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Datentyp: Zeichenfolge |
| result.asset.parameters_info | Eigenschaften der Trainingsdaten, die während des Lernprozesses gelernt werden. Beispiel: 7B oder 30B.Datentyp: Zeichenfolge |
| result.asset.supported_languages | Details zu den vom KI-Modell-Asset unterstützten Sprachen. Tabelle: Sprache [sys_language] Datentyp: Objekt |
| result.warnings | Kommagetrennte Liste mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sysId eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Im folgenden Beispiel wird ein KI-Modell-Asset gemäß den im Anforderungstext angegebenen Details erstellt.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d ' {
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"provider": "servicenow",
"documentation": "Now LLM V5 Documentation",
"version": "V8",
"parameters_info": "7B",
"supported_languages": [
"English",
"French"
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "31",
"base_model": "Servicenow Now LLM V6",
"model_weights_info": "refer to weights and biases project",
"required_infrastructre": "GPUs needed: 1, GPU Type: A100",
"training_datasets": [
"Servicenow Open Incidents"
],
"evaluation_datasets": [
"Servicenow Open Incidents"
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": "abel.tuter"
}'
{
"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 Asset-Eintrag für das KI-System in den Tabellen „Digitales Asset des KI-Systems“ [alm_ai_system_Digital_asset] und „Produktmodell des KI-Systems“ [cmdb_ai_system_product_model] gemäß den Details, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsnummer: /api/sn_ent/{api_version}/asset/ai_system
Standard-URL: /api/sn_ent/asset/ai_system
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Objekt | Erforderlich. Details, die im KI-System aktualisiert werden sollen. Datentyp: Objekt |
| objekt.name | Erforderlich. Name für das KI-Systemproduktmodell. Datentyp: Zeichenfolge |
| objekt.beschreibung | Beschreibung für das KI-Systemproduktmodell. Datentyp: Zeichenfolge |
| objekt.anbieter | Erforderlich. Wert des Felds „Anbieter“ in einem vorhandenen Datensatz der Tabelle „Unternehmen“ [core_company]. Gültige Werte:
Datentyp: Zeichenfolge |
| objekt.status | Status, der auf das KI-System-Asset angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Objekt.Version | Version des KI-Systemproduktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| objekt.dokumentation | Dokumentation des KI-System-Assets. Datentyp: Zeichenfolge Standard: |
| object.ai_models | Kommagetrennte Liste von Zeichenfolgen, wobei jede Zeichenfolge einen KI-Modell-Feldwert eines vorhandenen KI-Modell-Datensatzes für ein digitales Asset darstellt. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| object.evaluation_datasets | Kommagetrennte Liste von KI-Datensätzen, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-System-Asset [KI-System – Digitales Asset alm_ai_system_Digital_asset] Datentyp: Array Gültige Werte:
Standard: leere Zeichenfolge |
| object.evaluation_metrics_report | Verweis auf die Bewertungsergebnisse, die sich im Textfeld des Asset-Datensatzes des KI-Systems befinden. Zum Beispiel:Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| object.managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Tabellendatensatzes „Anwender“ [sys_user]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse des neuen KI-System-Assets. Datentyp: Objekt |
| result.asset | Details zum neu erstellten Eintrag. Datentyp: Objekt |
| result.asset.ai_models | Liste der KI-Modelle im Datensatz „Digitales Asset des KI-Systems“ [alm_ai_system_digital_asset]. Datentyp: Array |
| result.asset.ai_models.name | Name des Datensatzes der Tabelle „Digitales Asset des KI-Systems“ [alm_ai_system_digital_asset]. Datentyp: Zeichenfolge |
| result.asset.ai_models.sys_id | Sys_id des Tabellendatensatzes „KI-System – Digitales Asset“ [alm_ai_system_Digital_asset]. Datentyp: Zeichenfolge |
| result.asset.ai_prompts | Liste der KI-Hinweise für den Datensatz „Digitales Asset des KI-Systems“ [alm_ai_system_Digital_asset]. Datentyp: Array |
| result.asset.ai_prompts.name | Name der KI-Aufforderung. Datentyp: Zeichenfolge |
| result.asset.ai_prompts.sys_id | Sys_id des Tabellendatensatzes „KI-System – Digitales 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 |
| result.asset.evaluation_datasets | Liste der KI-Datensätze, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz Digitales Asset [alm_ai_dataset_Digital_asset], KI-System-Asset [alm_ai_system_Digital_asset] Datentyp: Array |
| result.asset.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.asset.evaluation_datasets.sys_id | Sys_id des Datensatzes der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset]. Datentyp: Zeichenfolge |
| result.asset.evaluation_metrics_report | Bewertungsergebnisse des KI-System-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.managed_by | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des KI-System-Assets, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Objekt |
| result.asset.managed_by.name | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Name | Name des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Wert des Felds „Anbieter“ im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Objekt |
| Ergebnis.Asset.Anbieter.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 Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_id eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Im folgenden Beispiel wird ein neuer Eintrag in die Tabellen „Digitales Asset des KI-Systems“ und „Produktmodell des KI-Systems“ eingefügt, indem die im Anforderungstext enthaltenen Details verwendet werden.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Incident Summarization",
"description": "Incident Summarization Skill",
"provider": "servicenow",
"documentation": "Sample Documentation",
"version": "V2",
"state": 31,
"ai_models": [
"llm_generic_small",
"mixtral-instruct"
],
"ai_prompts": [
"LLM Prompt"
],
"evaluation_datasets": [
"Base dataset"
],
"evaluation_metrics_report": "Sample Report",
"managed_by": "abel.tuter"
}'
Antworttext.
{
"result": {
"asset": {
"sys_id": "3b140397435a9210a63d00002fb8f2d7",
"display_name": "ServiceNow Incident Summarization V2",
"name": "Incident Summarization",
"description": "Incident Summarization Skill",
"version": "V2",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Sample Documentation",
"state": "Deployed",
"ai_models": [{
"sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",
"name": "llm_generic_small"
},
{
"sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2",
"name": "mixtral-instruct"
}],
"ai_prompts": [{
"sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "LLM Prompt"
}],
"evaluation_datasets": [{
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "Base dataset"
}],
"evaluation_metrics_report": "Sample Report",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-11 18:23:09",
"updated": "2024-12-11 18:23:09"
},
"warnings": []
}
}
KI-Assets-API – PUT /sn_ent/asset/ai_dataset/{sys_id}
Aktualisiert die Daten eines bestimmten Asset-Datensatzes des KI-Datensatzes gemäß den Informationen, die Sie im Anforderungstext angegeben haben.
Verwenden Sie die Methode KI-Assets-API – GET /sn_ent/asset/ai_dataset/{sys_id}, um einen vorhandenen KI-Datensatz mit einer bestimmten ID abzurufen. Sie können diese PUT-Methode dann verwenden, um Werte im Datensatz mit denselben ID-Informationen zu aktualisieren.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_dataset/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „KI-Datensatz-Asset“ [alm_ai_dataset_Digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| {Objekt} |
|
| {object}.acceptable_usage | Bestimmt, wie ein Datensatz oder ein Modell verwendet werden kann, normalerweise für Schulungs- oder Evaluierungszwecke. Gültige Werte:
Datentyp: Zeichenfolge |
| {object}.base_datasets | Kommagetrennte Liste der Basisdatensätze, die zum Erstellen dieses Datensatzes erforderlich sind. Akzeptiert Namen oder sys_ids von Datensätzen, die in der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset] vorhanden sind. Datentyp: Array |
| {object}.data_type | Typ der im Datensatz vorhandenen Daten. Zum Beispiel Text,Video,Image oder 1,2.Datentyp: Zeichenfolge |
| {object}.dataset_card | Die Datensatzkarte. Eine Datensatzkarte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es stellt Detailinformationen wie Datenquellen, Funktionen, beabsichtigte Verwendung und bekannte Einschränkungen bereit, um ein ordnungsgemäßes Verständnis und ordnungsgemäße Verwendung zu gewährleisten. Datentyp: Zeichenfolge |
| {object}.description | Beschreibung des zugeordneten Datensatzes in der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model]. Datentyp: Zeichenfolge |
| {object}.documentation | Dokumentation für das KI-Datensatz-Produktmodell. Datentyp: Zeichenfolge |
| {object}.managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Tabellendatensatzes „Anwender“ [sys_user]. Gültige Werte:
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:
Datentyp: Zeichenfolge |
| {Objekt}.Quelle | Details zur Quelle des Datensatzes. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| {object}.state | Status des KI-Datensatz-Assets. Gültige Werte:
Datentyp: Zeichenfolge |
| {Objekt}.Version | Versionsnummer des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Details des neu erstellten KI-Datensatz-Assets. Datentyp: Objekt |
| result.acceptable_usage | Zulässige Verwendung 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 |
| result.acceptable_usage.label | Bezeichnung des zulässigen Nutzungswerts anzeigen. Datentyp: Zeichenfolge |
| result.acceptable_usage.value | Zahlenwert der zulässigen Nutzung. Gültige Werte:
Datentyp: Zeichenfolge |
| result.base_datasets | Kommagetrennte Liste der Basisdatensätze, die zum Erstellen des angegebenen Datensatzes erforderlich sind. Akzeptiert den Namen oder die sys_id eines Basisdatensatzes in der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset]. Datentyp: Array |
| result.created | Datum und Uhrzeit der Erstellung des Datensatzes des 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 |
| result.data_type.label | Die Anzeigebezeichnung für den Datentypwert. Datentyp: Zeichenfolge |
| result.data_type.value | Wert des Datentyps des Datensatz-Assets. Datentyp: Zeichenfolge |
| result.dataset_card | Die Datensatzkarte. Eine Datensatzkarte ist ein Metadatendokument, das den Inhalt, die Struktur und den Kontext eines KI-Datensatzes beschreibt. Es stellt Detailinformationen wie Datenquellen, Funktionen, beabsichtigte Verwendung und bekannte Einschränkungen bereit, um ein ordnungsgemäßes Verständnis und ordnungsgemäße Verwendung zu gewährleisten. Datentyp: Zeichenfolge |
| result.description | Beschreibung des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. Tabelle: KI-Datensatz-Produktmodell [cmdb_ai_dataset_product_model] Datentyp: Zeichenfolge |
| result.display_name | Anzeigename des Asset-Datensatzes „KI-Datensatz“. Tabelle: KI-Datensatz Digitales Asset [alm_ai_dataset_digital_asset] Datentyp: Zeichenfolge |
| result.documentation | Dokumentation des zugehörigen Datensatzes der Tabelle „KI-Datensatz-Produktmodell“ [cmdb_ai_dataset_product_model]. Datentyp: Zeichenfolge |
| result.managed_by | Details zum Benutzer, der den Datensatz des KI-Datensatz-Assets verwaltet. Datentyp: Objekt |
| result.managed_by.name | Name des Benutzers, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.managed_by.sys_id | Sys_id des Anwenders, der den Datensatz des KI-Datensatz-Assets verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Name | Name des zugehörigen Datensatzes des KI-Datensatz-Produktmodells. 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 |
| Ergebnis.Anbieter.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 |
| result.source | Details zur Quelle des KI-Datensatz-Assets. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| result.state | Status des KI-Datensatz-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.sys_id | Sys_id des KI-Datensatz-Asset-Datensatzes. Tabelle: KI-Datensatz Digitales 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 des KI-Datensatz-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge |
| result.warnings | Kommagetrennte Liste der 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 |
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 Asset-Datensatzes für KI-Aufforderung gemäß den Informationen, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_prompt/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „Asset für KI-Aufforderung“ [alm_ai_prompt_digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Objekt | Erforderlich. Inhalt des zu aktualisierenden Assets der KI-Aufforderung. Datentyp: Objekt |
| ai_model | Wert des Felds „KI-Modell“ eines vorhandenen Datensatzes in der Tabelle „Digitales Asset des KI-Modells“ [alm_ai_model_Digital_asset]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| description | Beschreibung für das KI-Aufforderungsproduktmodell. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_prompt_product_model] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Dokumentation | Dokumentation des Produktmodells für KI-Eingabeaufforderungen. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Datensatzes in der Tabelle „Benutzer“ [sys_user]. Gültige Werte:
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“ | Aufforderungsinformationen für das Asset „KI-Aufforderung“. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Anbieter | Erforderlich. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes in der Tabelle „Unternehmen“ [core_company]. Gültige Werte:
Datentyp: Zeichenfolge |
| state | Status, der auf das KI-Modell-Asset angewendet werden soll. Beispiel: Gültige Werte:
Datentyp: Zeichenfolge |
| version | Versionsnummer zum Zuweisen des KI-Prompt-Produktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis |
|
| result.asset | Details zum neu erstellten Eintrag. Datentyp: Objekt |
| result.asset.ai_model | Liste der KI-Modelle im Datensatz der Tabelle „KI-System-Asset“ [cmdb_ai_system_asset_model]. Datentyp: Array |
| result.asset.ai_models.name | Name des Datensatzes der Tabelle „Digitales Asset des KI-Systems“ [alm_ai_system_digital_asset]. Datentyp: Zeichenfolge |
| result.asset.ai_models.sys_id | Sys_id des Tabellendatensatzes „KI-System – Digitales 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 |
| result.asset.managed_by | Details zum Benutzer, der das Asset verwaltet. Datentyp: Objekt |
| result.asset.managed_by.name | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Name | Name des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| result.asset.prompt_info | Aufforderungsinformationen des Asset-Datensatzes „KI-Aufforderung“. Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Wert des Felds „Anbieter“ im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Objekt |
| Ergebnis.Asset.Anbieter.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 Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_id eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Im folgenden Beispiel werden die Daten des Assets „KI-Eingabeaufforderung“ mit der angegebenen sys_id gemäß den angegebenen Parameterwerten im Anforderungstext aktualisiert.
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 angegeben haben.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_system/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „Digitales Asset für KI-Systeme“ [alm_ai_system_Digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Objekt | Erforderlich. Details, die im KI-System aktualisiert werden sollen. Datentyp: Objekt |
| objekt.name | Erforderlich. Name für das KI-Systemproduktmodell. Datentyp: Zeichenfolge |
| objekt.beschreibung | Beschreibung für das KI-Systemproduktmodell. Datentyp: Zeichenfolge |
| objekt.anbieter | Erforderlich. Wert des Felds „Anbieter“ in einem vorhandenen Datensatz der Tabelle „Unternehmen“ [core_company]. Gültige Werte:
Datentyp: Zeichenfolge |
| objekt.status | Status, der auf das KI-System-Asset angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Objekt.Version | Version des KI-Systemproduktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| objekt.dokumentation | Dokumentation des KI-System-Assets. Datentyp: Zeichenfolge Standard: |
| object.ai_models | Kommagetrennte Liste von Zeichenfolgen, wobei jede Zeichenfolge einen KI-Modell-Feldwert eines vorhandenen KI-Modell-Datensatzes für ein digitales Asset darstellt. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| object.evaluation_datasets | Kommagetrennte Liste von KI-Datensätzen, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-System-Asset [KI-System – Digitales Asset alm_ai_system_Digital_asset] Datentyp: Array Gültige Werte:
Standard: leere Zeichenfolge |
| object.evaluation_metrics_report | Verweis auf die Bewertungsergebnisse, die sich im Textfeld des Asset-Datensatzes des KI-Systems befinden. Zum Beispiel:Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| object.managed_by | Wert des Felds „Verwaltet von“ eines vorhandenen Tabellendatensatzes „Anwender“ [sys_user]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Fehler beim Abrufen des Assets mit der angegebenen sys_id. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse des aktualisierten KI-System-Assets. Datentyp: Objekt |
| result.asset | Details zum neu erstellten Asset. Datentyp: Objekt |
| result.ai_models | Liste der KI-Modelle im Datensatz der Tabelle „KI-System – Digitales Asset“ [alm_ai_system_Digital_asset]. Datentyp: Array |
| result.ai_models.name | Name des Datensatzes des digitalen Assets des KI-Systems. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.ai_models.sys_id | Sys_id des Datensatzes „Digitales Asset des KI-Systems“. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Zeichenfolge |
| result.ai_prompts | Liste der KI-Hinweismeldungen im Asset-Datensatz des KI-Systems. Datentyp: Array |
| result.ai_prompts.name | Name der KI-Aufforderung. Datentyp: Zeichenfolge |
| result.ai_prompts.sys_id | Sys_id des Datensatzes „Digitales Asset der KI-Aufforderung“. Tabelle: KI-Aufforderung für 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 |
| result.asset.evaluation_datasets | Liste der KI-Datensätze, die für die Auswertung des KI-System-Asset-Datensatzes verwendet werden. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz Digitales Asset [alm_ai_dataset_Digital_asset], KI-System-Asset [alm_ai_system_Digital_asset] Datentyp: Array |
| result.asset.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.asset.evaluation_datasets.sys_id | Sys_id des Datensatzes der Tabelle „KI-Datensatz Digitales Asset“ [alm_ai_dataset_digital_asset]. Datentyp: Zeichenfolge |
| result.asset.evaluation_metrics_report | Bewertungsergebnisse des KI-System-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.managed_by | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des KI-System-Assets, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabelle: Digitales Asset des KI-Systems [alm_ai_system_digital_asset] Datentyp: Objekt |
| result.asset.managed_by.name | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Name | Name des zugehörigen Datensatzes des KI-Systemproduktmodells. Tabelle: KI-Systemproduktmodell [cmdb_ai_system_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Wert des Felds „Anbieter“ im zugehörigen Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Objekt |
| Ergebnis.Asset.Anbieter.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 Datensatz der Tabelle „KI-Systemproduktmodell“ [cmdb_ai_system_product_model]. Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Assets. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Systems. Tabelle: Digitales Asset des KI-Systems [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 mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sys_id eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Im folgenden Beispiel wird das KI-System mit Details aktualisiert, 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, 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 Asset-Datensatzes für das KI-Modell gemäß den Informationen, die Sie im Anforderungstext angegeben haben.
URL-Format
URL mit Versionsangabe: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}
Standard-URL: /api/sn_ent/asset/ai_model/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Assets in der Tabelle „Asset für KI-Aufforderung“ [alm_ai_prompt_digital_asset]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Objekt | Erforderlich. Details, die im angegebenen KI-Modell aktualisiert werden sollen. Datentyp: Objekt |
| base_model | KI-Modell, von dem diese Modellversion abgeleitet wurde. Hinweis: Gilt nur für Modelle, die innerhalb der Organisation entwickelt wurden. Datentyp: Objekt 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: KI-Modell – Digitales Asset alm_ai_model_digital_asset Datentyp: Zeichenfolge |
| context_window | Größe der Eingabesequenzen (mit anderen Worten: 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 |
| description | Beschreibung für das KI-Modell-Produktmodell. Aktualisiert in Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge Standard: leer |
| Dokumentation | Dokumentation des Datensatzes „Produktmodell der KI-Aufforderung“. Tabelle: Produktmodell der KI-Aufforderung [cmdb_ai_model_product_model] Datentyp: Zeichenfolge Standard: leer |
| „evaluation_datasets“ | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des digitalen Assets „KI-Aufforderung“, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-Aufforderung – Digitales Asset [alm_ai_prompt_digital_asset] Datentyp: Array Gültige Werte:
Standard: leere Zeichenfolge |
| „evaluation_metrics_report“ | Verweis auf die Auswertungsergebnisse im Textfeld des Datensatzes „KI-Datensatz-Asset“. Zum Beispiel: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 Tabelle „Anwender“ [sys_user]. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer |
| model_size_in_mb | Größe des Modells in MB. Gilt hauptsächlich für Modelle, die in einer Organisation entwickelt und bereitgestellt werden. Datentyp: Zahl Standard: leer |
| model_weights_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 |
| parameter_info | Anzahl der Parameter, die dem Modell zugewiesen werden sollen. Datentyp: Zeichenfolge Standard: leere Zeichenfolge |
| Anbieter | Erforderlich. Wert des Felds „Anbieter“ eines vorhandenen Datensatzes der Tabelle „Unternehmen“ [core_company]. Weist diesen Anbieter dem neuen KI-Modell zu. Gültige Werte:
Datentyp: Zeichenfolge |
| „required_infrastructure“ | Dokumentation der Infrastrukturanforderungen für die Modellbereitstellung. Zum 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 dessen, wer oder was das Modell erstellt hat. Gültige Werte:
Datentyp: Zeichenfolge Standard: leer oder null |
| state | Status, der auf das KI-Modell-Asset angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| unterstützte_Sprachen | Kommagetrennte Liste der Sprachen, die vom KI-Modell unterstützt werden. Datentyp: Array Gültige Werte:
Standard: leere Zeichenfolge |
| „training_datasets“ | Verweis auf mehr als einen zugeordneten Datensatz, der zum Trainieren des Modells verwendet wird. 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 Standard: leere Zeichenfolge |
| „training_procedure“ | Typ des Trainings, das auf das KI-Modell angewendet werden soll. Gültige Werte:
Datentyp: Zeichenfolge, dargestellt durch eine Zahl (z. B. Standard: 1: Entscheidungsstrukturen |
| version | Version des KI-Modellproduktmodells. Beispiel: V2.Datentyp: Zeichenfolge Standard: leer |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse der Asset-Erstellung des KI-Modells. Datentyp: Objekt |
| result.asset | Details zum erstellten KI-Modell-Asset. Datentyp: Objekt |
| result.asset.base_model | Informationen zum Asset des KI-Modells, von dem diese Version abgeleitet wurde. Datentyp: Objekt |
| result.asset.base_model.name | Anzeigename des KI-Modell-Assets. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.base_model.sys_id | Sys_id des KI-Modell-Assets. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.context_window | Größe der Eingabesequenzen, die das Modell verarbeiten kann. Mit anderen Worten: die Anzahl der Token. Datentyp: Zeichenfolge, dargestellt durch eine Zahl. Beispiel: |
| 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 |
| Ergebnis.Asset.Beschreibung | Beschreibung des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.asset.display_name | Anzeigename des KI-Modell-Asset-Datensatzes. Tabelle: Digitales Asset „KI-Modell“ [alm_ai_model_digital_asset] (Feld „display_name“) Datentyp: Zeichenfolge |
| Ergebnis.Asset.Dokumentation | Dokumentation des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| result.asset.evaluation_datasets | Kommagetrennte Liste von sys_ids oder Anzeigenamen von KI-Datensätzen des digitalen Assets „KI-Modell“, das für die Bewertung des Modells verwendet wird. Gilt hauptsächlich für Modelle, die innerhalb einer Organisation entwickelt wurden. Tabellen: KI-Datensatz – Digitales Asset [alm_ai_dataset_Digital_asset], KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Array |
| result.evaluation_datasets.name | Name des digitalen Assets des KI-Datensatzes. Datentyp: Zeichenfolge |
| result.evaluation_datasets.sys_id | Sys_id des digitalen Asset-Datensatzes „KI-Modell“. Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.evaluation_metrics_report | Verweis auf die Auswertungsergebnisse. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.managed_by | Benutzer, der den Asset-Datensatz des KI-Modells verwaltet. Datentyp: Objekt |
| result.asset.managed_by.name | Name des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.managed_by.sys_id | Sys_id des Benutzers, der den Asset-Datensatz des KI-Modells verwaltet. Tabelle: Benutzer [user] Datentyp: Zeichenfolge |
| result.asset.model_size_in_mb | Größe des Modells in MB. Gilt normalerweise für Modelle, die in einer Organisation entwickelt und bereitgestellt werden. Datentyp: Zahl |
| result.asset.name | Name des zugehörigen Datensatzes „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Anbieter | Anbieter des zugehörigen KI-Modell-Produktmodelldatensatzes. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Objekt |
| 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 „KI-Modell-Produktmodell“ entspricht. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model] Datentyp: Zeichenfolge |
| Ergebnis.Asset.Quelle | Details zur Quelle des Assets. Gültige Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Asset.Status | Status des KI-Modell-Asset-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.asset.supported_languages.name | Name der unterstützten Sprache. Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.asset.supported_languages.sys_id | Sys_id der unterstützten Sprache. Tabelle: Sprache [sys_language] Datentyp: Zeichenfolge |
| result.asset.sys_id | Sys_id des Asset-Datensatzes des KI-Modells Tabelle: KI-Modell – Digitales Asset [alm_ai_model_digital_asset] Datentyp: Zeichenfolge |
| result.asset.training_datasets | Verweis auf mehr als einen zugeordneten Datensatz, der zum Trainieren des Modells verwendet wird. Datentyp: Array |
| result.asset.training_procedure | Typ des auf das Modell angewendeten KI-Trainings. Mögliche Werte:
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 „KI-Modell-Produktmodell“. Tabelle: KI-Modell Produktmodell [cmdb_ai_model_product_model table] Datentyp: Zeichenfolge |
| result.required_infrastructure | Dokumentation der Infrastrukturanforderungen für die Bereitstellung des Modells. Zum Beispiel Details zum Infrastrukturstapel und zu den Verarbeitungsanforderungen. Datentyp: Zeichenfolge |
| result.asset.parameters_info | Eigenschaften der Trainingsdaten, die während des Lernprozesses gelernt werden. Beispiel: 7B oder 30B.Datentyp: Zeichenfolge |
| result.asset.supported_languages | Details zu den vom KI-Modell-Asset unterstützten Sprachen. Tabelle: Sprache [sys_language] Datentyp: Objekt |
| result.warnings | Kommagetrennte Liste mit Warnmeldungen. Diese Warnungen können Validierungsprüfungen sein, z. B. wenn die sysId eines optionalen Parameters ungültig ist. Datentyp: Array |
cURL-Anforderung
Das folgende Beispiel zeigt, wie ein bestimmtes KI-Asset-Modell mit der PUT-Methode aktualisiert wird.
curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_model/9833721b331e92101c9aca989d5c7bf0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"provider": "servicenow",
"documentation": "Now LLM V5 Documentation",
"version": "V8",
"parameters_info": "7B",
"supported_languages": [
"English",
"French"
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "31",
"base_model": "Servicenow Now LLM V6",
"model_weights_info": "refer to weights and biases project",
"required_infrastructre": "GPUs needed: 1, GPU Type: A100",
"training_datasets": [
"Servicenow Open Incidents"
],
"evaluation_datasets": [
"Servicenow Open Incidents"
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": "abel.tuter"
}'
Antworttext.
{
"result": {
"asset": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"display_name": "ServiceNow Now LLM V6",
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"version": "V8",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Now LLM V5 Documentation",
"parameters_info": "7B",
"supported_languages": [
{
"sys_id": "914493a30f320010e96b0e4fef767e90",
"name": "English"
}
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "Deployed",
"required_infrastructure": "undefined",
"base_model": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"name": "ServiceNow Now LLM V8"
},
"evaluation_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"training_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-03 16:50:53",
"updated": "2024-12-12 15:56:28"
},
"warnings": [
"Reference record 'French' not found for supported_languages in table sys_language"
]
}
}