API des actifs IA

Actifs IA L’API fournit des points de terminaison pour récupérer, mettre à jour et créer plusieurs types d’actifs d’IA, tels que des systèmes, des ensembles de données, des invites et des modèles.

L’API Actifs IA prend en charge les actions que vous pouvez effectuer sur les enregistrements d’actifs IA dans le modèle développé et l’application Classes d’actifs. Le module d’extension Asset Classes (sn_ent) doit y accéder. Vous devez disposer des rôles d’actif et de model_manager pour appeler les points de terminaison fournis par l’API AI Assets.

Remarque :

Les données incluses dans les enregistrements d’actifs IA peuvent être réparties dans plusieurs tables telles que Modèle de produit, Élément de configuration, et autres. Toutefois, pour réduire la complexité lors de l’appel de cette API, l’API Actifs IA insère les données uniquement dans les tables Actif, Modèle de produit et Élément de configuration. Des détails sur les mises à jour de table sont fournis sous chaque point de terminaison.

API des actifs IA : GET /sn_ent/asset/ai_dataset/{sys_id}

Récupère les données de l’actif du jeu de données IA spécifié.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_dataset/{sys_id}

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 5. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

Nom	Description
résultat	Détails de l’actif du jeu de données IA nouvellement créé. Type de données : objet "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
result.acceptable_usage	Utilisation acceptable pour l’enregistrement d’actif du jeu de données IA. L’utilisation acceptable fait référence à la façon dont un ensemble de données ou un modèle peut être utilisé, généralement à des fins de formation ou d’évaluation. Type de données : objet "acceptable_usage": { "label": "String" "value": "String" }
result.acceptable_usage.étiquette	Affiche l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne
result.acceptable_usage.valeur	Valeur numérique de l’utilisation acceptable. Valeurs valides : 1 : Formation 2 : Évaluation Type de données : chaîne
result.base_datasets	Liste séparée par des virgules des jeux de données de base requis pour construire le jeu de données donné. Accepte le nom ou la sys_id d’un ensemble de données de base dans la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : tableau "base_datasets": ["String", "String"]
résultat.créé	Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.data_type	Type de données présentes dans l’enregistrement d’actif du jeu de données IA. Type de données : objet "data_type": { "label": "String", "value": "String" }
result.data_type.étiquette	Étiquette d’affichage de la valeur de type de données. Type de données : chaîne
result.data_type.valeur	Valeur du type de données de l’actif de l’ensemble de données. Type de données : chaîne
result.dataset_card	La carte de l’ensemble de données. Un dataset_card est un document de métadonnées qui décrit le contenu, la structure et le contexte d’un jeu de données sur l’IA. Il fournit des détails tels que les sources de données, les fonctionnalités, l’utilisation prévue et toutes les limitations connues pour garantir une compréhension et une utilisation appropriées. Type de données : chaîne
résultat.description	Description de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
result.display_name	Nom d’affichage de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.documentation	Documentation de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
result.managed_by	Détails sur l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.name	Nom de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
résultat.fournisseur	Fournisseur de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nom du fournisseur. Type de données : chaîne
result.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
résultat.source	Détails sur la source de l’actif du jeu de données IA. Valeurs valides : Lien vers la source de l’actif de l’ensemble de données. Détails (en texte brut) de la source de l’actif de l’ensemble de données. Par exemple, le nom d’un produit ou d’un site Web. Type de données : chaîne Valeur par défaut : vide ou nul
résultat.état	État de l’enregistrement d’actif du jeu de données IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.mis à jour	Date et heure de dernière mise à jour de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.version	Numéro de version de l’enregistrement de modèle de produit du jeu de données IA associé. Par exemple, V2. Type de données : chaîne

Demande cURL

L’exemple suivant.

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

Sortie :

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

API des actifs IA : GET /sn_ent/asset/ai_model/{sys_id}

Récupère les données de l’actif du modèle IA spécifié.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_model/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_model/{sys_id}

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif du modèle IA [alm_ai_model_digital_asset]. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 10. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 11. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

résultat	Détails de l’enregistrement de l’actif modèle. Type de données : objet result: { "base_model": {Object}, "context_window": "String", "created": "String", "deployment_guideline": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": {Object}, "model_size_in_mb": "String", "name": "String", "parameters_info": "String", "provider": {Object}, "required_infrastructure": "String", "source": "String", "state": Number, "supported_languages": [Array], "sys_id": "String", "training_datasets": [Array], "training_procedure": "String", "updated": "String", "version": "String" }
result.base_model	Modèle IA à partir duquel cette version de modèle a été dérivée. Remarque : Applicable uniquement aux modèles développés au sein de l’organisation. Type de données : objet { "name": "String", "sys_id": "String" } Faire défaut:
result.base_model.name	Nom de l’actif du modèle IA d’après lequel modéliser ce modèle IA. Type de données : chaîne
result.base_model.sys_id	Sys_id de l’actif du modèle IA à modéliser pour ce modèle IA. Type de données : chaîne
result.context_window	Taille des séquences d’entrée (en d’autres termes, le nombre de jetons) que le modèle peut gérer. Type de données : chaîne représentée par un nombre
résultat.créé	Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.deployment_guideline	Instructions applicables aux modèles développés et déployés au sein d’une organisation. Type de données : chaîne
résultat.description	Description à donner au modèle d’IA Modèle de produit. Mis à jour dans la table : Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
result.result.display_name	Nom d’affichage de l’enregistrement d’actif. Type de données : chaîne
résultat.documentation	Documentation de l’enregistrement du modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_model_product_model] Type de données : chaîne
result.evaluation_datasets	Liste séparée par des virgules des noms de sys_ids ou d’affichage des jeux de données IA de l’actif numérique du jeu de données IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : tableau "evaluation_datasets": [ "name": "String", "sys_id": "String" ]
result.evaluation_metrics_report	Référence aux résultats de l’évaluation. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.managed_by	Détails sur l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.model_size_in_mb	Taille du modèle en Mo. S’applique principalement aux modèles développés et déployés au sein d’une organisation. Type de données : nombre
result.name	Requis. Nom du modèle de produit du modèle IA. Mis à jour dans la table : Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
résultat.fournisseur	Fournisseur de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
result.provider.name	Nom du fournisseur. Type de données : chaîne
result.required_infrastructure	Documentation des besoins en infrastructure pour le déploiement du modèle. Par exemple, des détails sur la pile d’infrastructure et les besoins de traitement. S’applique principalement aux modèles déployés au sein d’une organisation. Type de données : chaîne
résultat.source	Détails sur la source du modèle. Valeurs possibles : Lien vers la source du modèle. Par exemple, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 ou un lien vers Github. Détails de la source en texte brut. Par exemple, Microsoft Azure Type de données : chaîne
résultat.état	État à appliquer à l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.supported_languages	Langues prises en charge par le modèle IA. Type de données : tableau "supported_languages": [ { "name": "String", "sys_id": "String" } ]
result.supported_languages.name	Nom de l’enregistrement de langue. Par exemple, « Français », « Anglais ». Table : Langue [sys_language] Type de données : chaîne
result.supported_languages.sys_id	Sys_id de l’enregistrement Langue. Table : Langue [sys_language] Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement de l’actif du modèle IA. Table : Actif du modèle IA [alm_ai_model_digital_asset] Type de données : chaîne
résultat.version	Version du modèle de produit du modèle IA. Par exemple, V2. Type de données : chaîne

Demande cURL

L’exemple suivant.

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

Sortie :

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

API des actifs IA : obtenir /sn_ent/asset/ai_prompt/{sys_id}

Récupère les données de l’actif d’invite IA spécifié.

Voir aussi :

• API des actifs IA : POST /sn_ent/asset/ai_prompt
• API des actifs IA : PUT /sn_ent/asset/ai_prompt/{sys_id}

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_prompt/{sys_id}

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif de l’invite IA [alm_ai_prompt_digital_asset]. Type de données : chaîne

Tableau 14. Paramètres de requête

Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 16. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 17. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

Nom	Description
résultat	Détails sur l’actif de l’invite IA. result: { "ai_model": {Object}, "created": "String", "description": "String", "display_name": "String", "documentation": "String", "managed_by": {Object}, "name": "String", "prompt_info": "String", "provider": {Object}, "state": Number, "sys_id": "String", "updated": "String", "version": "String" }
result.ai_model	Modèle IA de l’enregistrement d’actif de l’invite IA. Type de données : objet "ai_model": { "name": "String", "sys_id": "String" }
result.ai_model.name	Nom du modèle d’IA. Type de données : chaîne
result.ai_model.sys_id	Sys_id de l’enregistrement du modèle de produit de l’invite IA. Table : Modèle de produit de l’invite à l’IA [alm_ai_model_digital_asset] Type de données : chaîne
résultat.créé	Date et heure de création de l’enregistrement d’actif de l’invite IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.description	Description de l’enregistrement du modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne
result.display_name	Nom d’affichage de l’enregistrement d’actif de l’invite IA associé. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne
résultat.documentation	Documentation pour l’enregistrement du modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne
result.managed_by	Utilisateur qui gère l’enregistrement d’actif de l’invite IA. Type de données : objet "managed_by": { "name": "String", "sys_id": "String" }
result.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif. Type de données : chaîne
result.managed_by.sys_id	Sys_id de l’enregistrement Utilisateur qui correspond à l’enregistrement Géré par de l’actif Tables : Utilisateur [sys_user], Invite IA Actif [alm_ai_model_digital_asset] Type de données : chaîne
result.name	Nom du modèle de produit associé à l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne
result.prompt_info	Informations d’invite de l’enregistrement d’actif de l’invite IA. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne
résultat.fournisseur	Fournisseur de l’enregistrement de modèle de produit de l’invite IA. "provider": { "name": "String", "sys_id": "String" } Type de données : objet
result.provider.name	Nom de l’enregistrement de modèle de produit de l’invite IA associé. Type de données : chaîne
result.provider.sys_id	Sys_id de l’enregistrement de la table Société [core_company] qui correspond au fournisseur de l’enregistrement de modèle de produit associé à l’invite IA. Tables : Société [core_company], Modèle de produit de l’invite IA [cmdb_ai_prompt_product_model] Type de données : chaîne
résultat.état	État de l’enregistrement d’actif de l’invite IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement de l’actif de l’invite IA. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne
résultat.mis à jour	Date et heure de dernière mise à jour de l’enregistrement d’actif de l’invite IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.version	Version de l’enregistrement de modèle de produit de l’invite IA associé. Par exemple, V2. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment récupérer des informations sur un modèle d’actif de l’invite IA à l’aide d’un ID spécifique.

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

Le corps de la réponse renvoie des détails sur le modèle d’actif d’invite spécifique qui a été récupéré.

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

API des actifs IA : GET /sn_ent/asset/ai_system/{sys_id}

Récupère les données de l’actif du système IA spécifié.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_system/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_system/{sys_id}

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Néant

Tableau 21. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 22. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 23. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

Nom	Description
résultat	Détails sur l’actif du système IA récupéré. result: { "ai_models": [Array], "ai_prompts": [Array], "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": Number, "sys_id": "String", "updated": "String", "version": "String" }
result.ai_models	Liste des modèles IA dans l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : tableau "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.ai_models.name	Nom de l’enregistrement d’actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.ai_models.sys_id	Sys_id de l’enregistrement de l’actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.ai_prompts	Liste des invites IA dans l’enregistrement d’actif du système IA. Type de données : tableau "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.ai_prompts.name	Nom de l’invite IA. Type de données : chaîne
result.ai_prompts.sys_id	Sys_id de l’enregistrement de l’actif numérique de l’invite IA. Table : Actif numérique de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne
résultat.créé	Date et heure de création de l’actif du système IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.description	Description de l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.display_name	Nom d’affichage de l’enregistrement d’actif du système IA. Table : Actif du système IA [cmdb_ai_ system_asset_model] Type de données : chaîne
résultat.documentation	Documentation pour l’enregistrement système du produit système IA. Table : Système de produit système d’IA [cmdb_ai_system_product_system] Type de données : chaîne
result.evaluation_datasets	Liste des jeux de données IA utilisés pour évaluer le modèle dans l’enregistrement Actif numérique du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du système IA [alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ] Par défaut : chaîne vide
result.evaluation_datasets.nom	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.evaluation_datasets.sys_id	Sys_id de l’enregistrement de l’actif numérique du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
result.evaluation_metrics_report	Résultats de l’évaluation de l’enregistrement de l’actif du système IA. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.managed_by	Détails sur l’utilisateur qui gère l’enregistrement d’actif du système IA. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.nom	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du système IA. Table : Utilisateur [user] Type de données : chaîne
result.managed_by.sys_id	Nom de l’utilisateur qui gère l’enregistrement d’actif du système IA. Table : Utilisateur [user] Type de données : chaîne
result.name	Nom de l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
résultat.fournisseur	Valeur du champ Fournisseur dans l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nom du fournisseur dans l’enregistrement de modèle de produit de système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.provider.sys_id	Sys_id du fournisseur dans l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
résultat.état	État de l’enregistrement d’actif du système IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.mis à jour	Date et heure de dernière mise à jour de l’actif du système IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.version	Numéro de version de l’enregistrement de modèle de produit du système IA associé. Par exemple, V2. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment récupérer un actif de modèle de système IA avec un ID donné.

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

Le corps de la réponse renvoie des détails sur l’actif de modèle de système IA donné.

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

API des actifs IA : POST /sn_ent/asset/ai_dataset

Crée une nouvelle entrée d’actif de jeu de données IA dans l’actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] et le modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] en fonction des détails que vous fournissez dans le corps de la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_dataset

URL par défaut : /api/sn_ent/asset/ai_dataset

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 26. Paramètres de requête

Nom	Description
Néant

Tableau 27. Paramètres de corps de demande (XML ou JSON)

Nom	Description
{objet}	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
{objet}	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
{objet}.acceptable_usage	Détermine comment un ensemble de données ou un modèle peut être utilisé, généralement à des fins de formation ou d’évaluation. Valeurs valides : 1 : Formation 2 : Évaluation Type de données : chaîne
{objet}.base_datasets	Liste séparée par des virgules des ensembles de données de base nécessaires à la construction de cet ensemble de données. Accepte les noms ou les sys_ids des jeux de données présents dans la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : tableau “base_datasets”: [ “String”, “String”]
{objet}.data_type	Type de données présentes dans l’ensemble de données. Par exemple, Texte, Vidéo, Image ou 1,2. Type de données : chaîne
{objet}.dataset_card	La carte de l’ensemble de données. Un dataset_card est un document de métadonnées qui décrit le contenu, la structure et le contexte d’un jeu de données sur l’IA. Il fournit des détails tels que les sources de données, les fonctionnalités, l’utilisation prévue et toutes les limitations connues pour garantir une compréhension et une utilisation appropriées. Type de données : chaîne
{objet}.description	Description de l’enregistrement associé dans la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
{objet}.documentation	Documentation pour le modèle de produit du jeu de données IA. Type de données : chaîne
{objet}.managed_by	Valeur du champ Géré par d’un enregistrement de table Utilisateur [sys_user] existant. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne
{objet}.nom	Requis. Nom de l’enregistrement associé dans la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
{objet}.fournisseur	Requis. Valeur du champ Fournisseur d’un enregistrement existant dans la table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
{objet}.source	Détails sur la source de l’ensemble de données. Valeurs valides : Lien vers la source de l’ensemble de données. Détails de la source en texte brut. Type de données : chaîne Valeur par défaut : vide ou nul
{objet}.état	État de l’actif du jeu de données IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
{objet}.version	Numéro de version de l’enregistrement de modèle de produit du jeu de données IA associé. Par exemple, V2. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 28. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 29. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Détails de l’actif du jeu de données IA nouvellement créé. Type de données : objet "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
result.acceptable_usage	Utilisation acceptable pour l’enregistrement d’actif du jeu de données IA. L’utilisation acceptable fait référence à la façon dont un ensemble de données ou un modèle peut être utilisé, généralement à des fins de formation ou d’évaluation. Type de données : objet "acceptable_usage": { "label": "String" "value": "String" }
result.acceptable_usage.étiquette	Affiche l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne
result.acceptable_usage.valeur	Valeur numérique de l’utilisation acceptable. Valeurs valides : 1 : Formation 2 : Évaluation Type de données : chaîne
result.base_datasets	Liste séparée par des virgules des jeux de données de base requis pour construire le jeu de données donné. Accepte le nom ou la sys_id d’un ensemble de données de base dans la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : tableau "base_datasets": ["String", "String"]
résultat.créé	Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.data_type	Type de données présentes dans l’enregistrement d’actif du jeu de données IA. Type de données : objet "data_type": { "label": "String", "value": "String" }
result.data_type.étiquette	Étiquette d’affichage de la valeur de type de données. Type de données : chaîne
result.data_type.valeur	Valeur du type de données de l’actif de l’ensemble de données. Type de données : chaîne
result.dataset_card	La carte de l’ensemble de données. Un dataset_card est un document de métadonnées qui décrit le contenu, la structure et le contexte d’un jeu de données sur l’IA. Il fournit des détails tels que les sources de données, les fonctionnalités, l’utilisation prévue et toutes les limitations connues pour garantir une compréhension et une utilisation appropriées. Type de données : chaîne
résultat.description	Description de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
result.display_name	Nom d’affichage de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.documentation	Documentation de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
result.managed_by	Détails sur l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.name	Nom de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
résultat.fournisseur	Fournisseur de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
result.provider.name	Nom du fournisseur. Type de données : chaîne
résultat.source	Détails sur la source de l’actif du jeu de données IA. Valeurs valides : Lien vers la source de l’actif de l’ensemble de données. Détails (en texte brut) de la source de l’actif de l’ensemble de données. Par exemple, le nom d’un produit ou d’un site Web. Type de données : chaîne Valeur par défaut : vide ou nul
résultat.état	État de l’enregistrement d’actif du jeu de données IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.mis à jour	Date et heure de dernière mise à jour de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.version	Numéro de version de l’enregistrement de modèle de produit du jeu de données IA associé. Par exemple, V2. Type de données : chaîne
résultat.avertissements	Liste séparée par des virgules des messages d’avertissement présents lors de la création de l’ensemble de données. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant montre comment créer un nouvel enregistrement d’actif de jeu de données IA.

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

Corps de la réponse. Résultats de l’enregistrement d’actif de l’ensemble de données nouvellement créé.

{ 
  "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": [] 
       } 
}

API des actifs IA : POST /sn_ent/asset/ai_prompt

Crée une nouvelle entrée d’actif de l’invite IA dans les tables Actif numérique de l’invite à l’IA [alm_ai_prompt_digital_asset] et Modèle de produit de l’invite à l’IA [cmdb_ai_promt_product_model] en fonction des détails que vous fournissez dans le corps de la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_prompt

URL par défaut : /api/sn_ent/asset/ai_prompt

Paramètres de demande pris en charge

Tableau 31. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 32. Paramètres de requête

Nom	Description
Néant

Tableau 33. Paramètres de corps de demande (XML ou JSON)

Nom	Description
objet	Requis. Contenu de l’actif de l’invite IA à mettre à jour. Type de données : objet { "ai_model": "String", "description": "String", "documentation": "String", "managed_by": "String" "name": "String", "prompt_info": "String", "provider": "String", "state": Number, "version": "String" }
ai_model	Valeur du champ Modèle IA d’un enregistrement existant dans la table Actif numérique du modèle IA [alm_ai_model_digital_asset]. Valeurs valides : Nom de l’enregistrement d’actif numérique [alm_ai_model_digital_asset] du modèle d’IA Sys_id de l’enregistrement de l’actif numérique du modèle IA [alm_ai_model_digital_asset] Type de données : chaîne Par défaut : chaîne vide
description	Description à donner au modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne Par défaut : chaîne vide
interne	Documentation du modèle de produit de l’invite IA. Type de données : chaîne Par défaut : chaîne vide
managed_by	Valeur du champ Géré par d’un enregistrement existant dans la table Utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Par défaut : chaîne vide
nom	Requis. Nom de l’enregistrement associé dans la table Modèle de produit de l’invite IA [cmdb_ai_prompt_product_model]. Type de données : chaîne Par défaut : chaîne vide
prompt_info	Informations d’invite pour l’actif d’invite IA. Type de données : chaîne Par défaut : chaîne vide
fournisseur	Requis. Valeur du champ Fournisseur d’un enregistrement existant dans la table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
État	État à appliquer à l’actif du modèle IA. Par exemple : Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
version	Numéro de version pour affecter le modèle de produit de l’invite IA. Par exemple, V2. Type de données : chaîne Par défaut : chaîne vide

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 34. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 35. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 36. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Résultats de la nouvelle invite d’actif IA. Type de données : objet "result": { "asset": Object, "warnings": [Array] }
résultat.actif	Détails sur l’entrée nouvellement créée. Type de données : objet "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
result.asset.ai_model	Liste des modèles IA dans l’enregistrement de la table Actif du système IA [cmdb_ai_ system_asset_model]. Type de données : tableau "ai_model": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.name	Nom de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
result.asset.ai_models.sys_id	Sys_id de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
result.asset.ai_prompts	Liste des invites IA de l’enregistrement d’actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_prompts.name	Nom de l’invite IA. Type de données : chaîne
result.asset.ai_prompts.sys_id	Sys_id de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model] associé. Type de données : chaîne
result.asset.evaluation_datasets	Liste des noms de sys_ids ou d’affichage des jeux de données IA utilisés pour évaluer le modèle d’actif du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.name	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.asset.evaluation_datasets.sys_id	Sys_id de l’enregistrement de l’actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.asset.evaluation_metrics_report	Résultats de l’évaluation de l’actif du système IA. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.asset.managed_by	Détails sur l’utilisateur qui gère l’actif. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.name	Nom de l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
résultat.actif.fournisseur	Valeur du champ Fournisseur dans l’enregistrement de table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
result.asset.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
résultat.asset.state	État de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.avertissement	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant montre comment utiliser la méthode POST pour créer une nouvelle invite IA en fonction des détails fournis dans le corps de la demande.

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

Corps de la réponse.

{ 
  "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 des actifs IA : POST /sn_ent/asset/ai_model

Crée une nouvelle entrée d’actif de modèle IA dans les tables Actif numérique du modèle IA [alm_ai_model_digital_asset] et Modèle de produit du modèle IA [cmdb_ai_model_product_model] en fonction des détails que vous fournissez dans le corps de la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_model

URL par défaut : /api/sn_ent/asset/ai_model

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 38. Paramètres de requête

Nom	Description
Néant

Tableau 39. Paramètres de corps de demande (XML ou JSON)

Nom	Description
{objet}	Requis. Détails à appliquer au nouvel enregistrement de modèle d’actif. Type de données : objet "object": { "base_model": {Object}, "context_window:" "String", "deployment_guideline": "String", "description": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String", "model_size_in_mb": "String", "model_weights_info": "String", "name": "String", "parameters_info": "String", "provider": "String", "required_infrastructure": "String", "source": "String", "state": Number, "supported_languages: [Array], "training_datasets": [Array], "training_procedure": "String", "version": "String" }
{objet}.base_model	Modèle IA à partir duquel cette version de modèle a été dérivée. Remarque : Applicable uniquement aux modèles développés au sein de l’organisation. Type de données : objet { "name": "String", "sys_id": "String" }
{objet}.base_model.nom	Nom de l’actif du modèle IA d’après lequel modéliser ce modèle IA. Type de données : chaîne
{objet}.base_model.sys_id	Sys_id de l’actif du modèle IA à modéliser pour ce modèle IA. Table : Actif numérique du modèle IA [alm_ai_dataset_digital_asset] Type de données : chaîne Par défaut : chaîne vide
{objet}.context_window	Taille des séquences d’entrée (en d’autres termes, le nombre de jetons) que le modèle peut gérer. Type de données : nombre entier Valeur par défaut : valeur vide
{objet}.deployment_guideline	Instructions applicables aux modèles développés et déployés au sein d’une organisation. Type de données : chaîne Par défaut : chaîne vide
{objet}.description	Description à donner au modèle d’IA Modèle de produit. Table mise à jour : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne Par défaut : chaîne vide
{objet}.documentation	Documentation du modèle de produit du modèle IA. Type de données : chaîne Par défaut : chaîne vide
{objet}.evaluation_datasets	Liste séparée par des virgules des noms de sys_ids ou d’affichage des jeux de données IA des jeux de données IA utilisés pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du modèle IA [alm_ai_model_digital_asset] Type de données : tableau "evaluation_datasets": ["String", "String"] Valeurs valides : Nom de l’enregistrement d’actif numérique du jeu de données IA. Sys_id de l’enregistrement de l’actif numérique du jeu de données IA. Par défaut : chaîne vide
{objet}.evaluation_metrics_report	Référence aux résultats de l’évaluation situés dans le champ de texte de l’enregistrement de l’actif numérique du modèle IA. Par exemple : Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Table : Actif numérique du modèle IA [alm_ai_model_digital_asset] Type de données : chaîne Par défaut : chaîne vide
{objet}.managed_by	Valeur du champ « Géré par » d’un enregistrement existant dans la table Utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Par défaut : chaîne vide
{objet}.model_size_in_mb	Taille du modèle en Mo. S’applique principalement aux modèles développés et déployés au sein d’une organisation. Type de données : nombre Valeur par défaut : nul ou vide
{objet}.model_weights_info	Informations supplémentaires sur le modèle, le cas échéant. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : chaîne Valeur par défaut : nul ou vide
{objet}.nom	Requis. Nom du modèle de produit du modèle IA. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne Valeur par défaut : nul ou vide
{objet}.parameters_info	Nombre de paramètres attribués au modèle. Type de données : chaîne Par défaut : chaîne vide
{objet}.fournisseur	Requis. Valeur du champ « Fournisseur » de l’enregistrement existant dans la table Société [core_company]. Affecte ce fournisseur au nouveau modèle d’IA. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne Par défaut : chaîne vide
{objet}.required_infrastructure	Documentation des besoins en infrastructure pour le déploiement du modèle. Par exemple, des détails sur la pile d’infrastructure et les besoins de traitement. S’applique principalement aux modèles déployés au sein d’une organisation. Type de données : chaîne Valeur par défaut : vide ou nul
{objet}.source	Détails sur la source de qui ou de quoi a créé le modèle. Valeurs valides : Lien vers la source du modèle. Par exemple, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 ou un lien vers Github. Détails de la source en texte brut. Par exemple, Microsoft Azure Type de données : chaîne Valeur par défaut : vide ou nul
{objet}.état	État à appliquer à l’actif du modèle IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
{objet}.supported_languages	Liste séparée par des virgules des langues prises en charge par le modèle IA. Type de données : tableau "supported_languages": [ "String", "String" ] Valeurs valides : Sys_id de l’enregistrement de la langue [sys_language] Nom de l’enregistrement de langue [sys_language]. Par exemple, « Français », « Anglais ». Par défaut : chaîne vide
{objet}.training_datasets	Ensembles de données utilisés pour former le modèle IA. Liste séparée par des virgules des noms d’sys_ids ou d’affichage de la table Actif du jeu de données IA [alm_ai_dataset_digital_asset]. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : tableau "training_datasets": [ "String", "String" ] Par défaut : chaîne vide
{objet}.training_procedure	Type de formation à appliquer au modèle IA. Valeurs valides : 1 : Arborescences de décision 2 : Réseaux de neurones profonds 3 : Régression linéaire 4 : Régression logistique 5 : Forêt aléatoire 6 : Apprentissage supervisé 7 : Apprentissage non supervisé 8 : Apprentissage par renforcement 9 : Apprentissage par transfert 10 : Apprentissage semi-supervisé 11 : Affinage des instructions 12 : Mise au point supervisée Type de données : chaîne représentée par un nombre (par exemple, « 3 ») Par défaut : 1 : Arborescences de décision
{objet}.version	Version du modèle de produit du modèle IA. Par exemple, V2. Type de données : chaîne Par défaut : chaîne vide

Paramètres du corps de la réponse (JSON ou XML)

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 40. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 41. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 42. Codes d'état

Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Résultats de la création de l’actif du modèle IA. Type de données : objet "result": { "asset": Object, "warnings": [Array], }
résultat.actif	Détails sur l’actif du modèle IA créé. Type de données : objet "asset": { "base_model": Object, "context_window": String, "created": "String", "deployment_guideline": String, "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "model_size_in_mb": String, "name": "String", "parameters_info": "String", "provider": Object, "required_infrastructure": String, "state": "String", "source": String, "supported_languages": Array, "sys_id": "String", "training_datasets": Array, "training_procedure": String, "updated": "String", "version": "String" }
result.asset.base_model	Informations sur l’actif du modèle IA d’où provient cette version. Type de données : objet "base_model": { "name": "String", "sys_id": "String" }
result.asset.base_model.name	Nom d’affichage de l’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.base_model.sys_id	Sys_id de l’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.context_window	Taille des séquences d’entrées que le modèle peut gérer. En d’autres termes, le nombre de jetons. Type de données : chaîne représentée par un nombre. Par exemple, « 6000 ».
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.asset.deployment_guideline	Instructions applicables aux modèles développés et déployés au sein d’une organisation. Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] (champ display_name) Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
result.asset.evaluation_datasets	Liste séparée par des virgules des noms de sys_ids ou d’affichage des jeux de données IA de l’actif numérique du modèle IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif numérique du modèle IA [alm_ai_model_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.evaluation_datasets.nom	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.evaluation_datasets.sys_id	Sys_id de l’enregistrement de l’actif numérique du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.evaluation_metrics_report	Référence aux résultats de l’évaluation. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.asset.managed_by	Utilisateur qui gère l’enregistrement d’actif du modèle IA. Type de données : objet " managed_by": { "name": "String", "sys_id": "String" }
result.asset.managed_by.name	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.model_size_in_mb	Taille du modèle en Mo. S’applique généralement aux modèles développés et déployés au sein d’une organisation. Type de données : nombre
result.asset.name	Nom de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
résultat.actif.fournisseur	Fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : objet "provider": { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur. Type de données : chaîne
result.asset.provider.sys_id	Sys_id de l’enregistrement de la table Société [core_company] qui correspond au fournisseur de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
résultat.actif.source	Détails sur la source de l’actif. Valeurs valides : Lien vers la source du modèle. Par exemple, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 ou un lien vers Github. Détails de la source en texte brut. Par exemple, Microsoft Azure Type de données : chaîne
résultat.asset.state	État de l’enregistrement de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.supported_languages.name	Nom de la langue prise en charge. Table : Langue [sys_language] Type de données : chaîne
result.asset.supported_languages.sys_id	Sys_id de la langue prise en charge. Table : Langue [sys_language] Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement de l’actif du modèle IA Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.training_datasets	Référence à 1+ ensembles de données associés utilisés pour la formation du modèle. Type de données : tableau "training_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.training_procedure	Type de formation de l’IA appliquée au modèle. Valeurs possibles : 1 : Arborescences de décision 2 : Réseaux de neurones profonds 3 : Régression linéaire 4 : Régression logistique 5 : Forêt aléatoire 6 : Apprentissage supervisé 7 : Apprentissage non supervisé 8 : Apprentissage par renforcement 9 : Apprentissage par transfert 10 : Apprentissage semi-supervisé 11 : Affinage des instructions 12 : Mise au point supervisée Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.version	Version de l’enregistrement de modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model table] Type de données : chaîne
result.required_infrastructure	Documentation des besoins en infrastructure pour le déploiement du modèle. Par exemple, des détails sur la pile d’infrastructure et les besoins de traitement. Type de données : chaîne
result.asset.parameters_info	Propriétés des données de formation qui apprennent au cours du processus d’apprentissage. Par exemple : 7B ou 30B. Type de données : chaîne
result.asset.supported_languages	Détails sur les langues prises en charge par l’actif de modèle IA. Table : Langue [sys_language] Type de données : objet "supported_languages": [ { "name": "String", "sys_id": "String" } ]
résultat.avertissements	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des vérifications de validation, par exemple lorsque le sysId d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant crée un actif de modèle IA en fonction des détails fournis dans le corps de la demande.

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

Le corps de la réponse affiche les détails de l’actif de modèle IA nouvellement créé, y compris les sys_id résultants.

{
  "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"
    ]
  }
}

API des actifs IA : POST /sn_ent/asset/ai_system

Crée une nouvelle entrée d’actif de système IA dans les tables Actif numérique de système IA [alm_ai_system_digital_asset] et Modèle de produit de système IA [cmdb_ai_system_product_model] en fonction des détails que vous fournissez dans le corps de la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_system

URL par défaut : /api/sn_ent/asset/ai_system

Paramètres de demande pris en charge

Tableau 43. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 44. Paramètres de requête

Nom	Description
Néant

Tableau 45. Paramètres de corps de demande (XML ou JSON)

Nom	Description
objet	Requis. Détails à mettre à jour dans le système IA. Type de données : objet { "name": "String", "description": "String", "provider": "String", "version": "String", "state": Number, "documentation": "String", "ai_models": "String", "ai_prompts": "Strings", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String" }
object.name	Requis. Nom du modèle de produit du système IA. Type de données : chaîne
Objet.description	Description du modèle de produit du système IA. Type de données : chaîne
Fournisseur.objet	Requis. Valeur du champ Fournisseur dans un enregistrement de table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
état.objet	État à appliquer à l’actif du système IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne Par défaut : chaîne vide
version.objet	Version du modèle de produit du système IA. Par exemple, V2. Type de données : chaîne Par défaut : chaîne vide
objet.documentation	Documentation de l’actif du système IA. Type de données : chaîne Faire défaut:
object.ai_models	Liste de chaînes séparées par des virgules, où chaque chaîne représente une valeur de champ de modèle IA d’un enregistrement d’actif numérique de modèle IA existant. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Valeurs valides : Nom de l’enregistrement d’actif numérique du modèle d’IA. Sys_id de l’enregistrement de l’actif numérique du modèle IA. Type de données : chaîne Par défaut : chaîne vide
object.evaluation_datasets	Liste séparée par des virgules des jeux de données sur l’IA utilisés pour évaluer l’enregistrement de l’actif du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du système IA [Actif numérique du système IA alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [{String", "String"}] Valeurs valides : Nom de l’enregistrement d’actif numérique du jeu de données IA. Sys_id de l’enregistrement de l’actif numérique du jeu de données IA. Par défaut : chaîne vide
object.evaluation_metrics_report	Référence aux résultats de l’évaluation situés dans le champ de texte de l’enregistrement d’actif du système IA. Par exemple : Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne Par défaut : chaîne vide
object.managed_by	Valeur du champ « Géré par » d’un enregistrement de table d’utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Par défaut : chaîne vide

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 46. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 47. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 48. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Résultats du nouvel actif du système IA. Type de données : objet "result": { "asset": Object, "warnings": [Array] }
résultat.actif	Détails sur l’entrée nouvellement créée. Type de données : objet "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
result.asset.ai_models	Liste des modèles d’IA dans l’enregistrement Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : tableau "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.nom	Nom de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
result.asset.ai_models.sys_id	Sys_id de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
result.asset.ai_prompts	Liste des invites IA de l’enregistrement Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : tableau "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_prompts.nom	Nom de l’invite IA. Type de données : chaîne
result.asset.ai_prompts.sys_id	Sys_id de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model] associé. Type de données : chaîne
result.asset.evaluation_datasets	Liste des jeux de données IA utilisés pour évaluer l’enregistrement d’actif du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du système IA [alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.nom	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.asset.evaluation_datasets.sys_id	Sys_id de l’enregistrement de la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : chaîne
result.asset.evaluation_metrics_report	Résultats de l’évaluation de l’actif du système IA. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.asset.managed_by	Liste séparée par des virgules des sys_ids ou des noms d’affichage des jeux de données IA de l’actif du système IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.nom	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.name	Nom de l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
résultat.actif.fournisseur	Valeur du champ Fournisseur dans l’enregistrement de table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
result.asset.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
résultat.asset.state	État de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.version	Numéro de version de l’enregistrement de modèle de produit du système IA associé. Par exemple, V2. Type de données : chaîne
résultat.actif.avertissements	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant insère une nouvelle entrée dans les tables Actif numérique du système IA et Modèle de produit du système IA à l’aide des détails inclus dans le corps de la demande.

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

Corps de la réponse.

{ 
  "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": [] 
  } 
}

API des actifs IA : PUT /sn_ent/asset/ai_dataset/{sys_id}

Met à jour les données d’un enregistrement d’actif de jeu de données IA spécifique en fonction des informations que vous fournissez dans le corps de la demande.

Remarque :

Fournissez uniquement les paires paramètre-valeur pour les données spécifiques que vous souhaitez mettre à jour. Ce point de terminaison remplace les données pour tous les paramètres envoyés dans la demande.

Utilisez la API des actifs IA : GET /sn_ent/asset/ai_dataset/{sys_id} méthode pour récupérer un enregistrement d’ensemble de données IA existant avec un ID donné. Vous pouvez ensuite utiliser cette méthode PUT pour mettre à jour les valeurs du jeu de données à l’aide des mêmes informations d’ID.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_dataset/{sys_id}

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : chaîne

Tableau 50. Paramètres de requête

Nom	Description
Néant

Tableau 51. Paramètres de corps de demande (XML ou JSON)

Nom	Description
{objet}	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
{objet}.acceptable_usage	Détermine comment un ensemble de données ou un modèle peut être utilisé, généralement à des fins de formation ou d’évaluation. Valeurs valides : 1 : Formation 2 : Évaluation Type de données : chaîne
{objet}.base_datasets	Liste séparée par des virgules des ensembles de données de base nécessaires à la construction de cet ensemble de données. Accepte les noms ou les sys_ids des jeux de données présents dans la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : tableau “base_datasets”: [ “String”, “String”]
{objet}.data_type	Type de données présentes dans l’ensemble de données. Par exemple, Texte, Vidéo, Image ou 1,2. Type de données : chaîne
{objet}.dataset_card	La carte de l’ensemble de données. Un dataset_card est un document de métadonnées qui décrit le contenu, la structure et le contexte d’un jeu de données sur l’IA. Il fournit des détails tels que les sources de données, les fonctionnalités, l’utilisation prévue et toutes les limitations connues pour garantir une compréhension et une utilisation appropriées. Type de données : chaîne
{objet}.description	Description de l’enregistrement associé dans la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
{objet}.documentation	Documentation pour le modèle de produit du jeu de données IA. Type de données : chaîne
{objet}.managed_by	Valeur du champ Géré par d’un enregistrement de table Utilisateur [sys_user] existant. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne
{objet}.nom	Requis. Nom de l’enregistrement associé dans la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
{objet}.fournisseur	Requis. Valeur du champ Fournisseur d’un enregistrement existant dans la table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
{objet}.source	Détails sur la source de l’ensemble de données. Valeurs valides : Lien vers la source de l’ensemble de données. Détails de la source en texte brut. Type de données : chaîne Valeur par défaut : vide ou nul
{objet}.état	État de l’actif du jeu de données IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
{objet}.version	Numéro de version de l’enregistrement de modèle de produit du jeu de données IA associé. Par exemple, V2. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 52. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 53. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 54. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Détails de l’actif du jeu de données IA nouvellement créé. Type de données : objet "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
result.acceptable_usage	Utilisation acceptable pour l’enregistrement d’actif du jeu de données IA. L’utilisation acceptable fait référence à la façon dont un ensemble de données ou un modèle peut être utilisé, généralement à des fins de formation ou d’évaluation. Type de données : objet "acceptable_usage": { "label": "String" "value": "String" }
result.acceptable_usage.étiquette	Affiche l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne
result.acceptable_usage.valeur	Valeur numérique de l’utilisation acceptable. Valeurs valides : 1 : Formation 2 : Évaluation Type de données : chaîne
result.base_datasets	Liste séparée par des virgules des jeux de données de base requis pour construire le jeu de données donné. Accepte le nom ou la sys_id d’un ensemble de données de base dans la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : tableau "base_datasets": ["String", "String"]
résultat.créé	Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.data_type	Type de données présentes dans l’enregistrement d’actif du jeu de données IA. Type de données : objet "data_type": { "label": "String", "value": "String" }
result.data_type.étiquette	Étiquette d’affichage de la valeur de type de données. Type de données : chaîne
result.data_type.valeur	Valeur du type de données de l’actif de l’ensemble de données. Type de données : chaîne
result.dataset_card	La carte de l’ensemble de données. Un dataset_card est un document de métadonnées qui décrit le contenu, la structure et le contexte d’un jeu de données sur l’IA. Il fournit des détails tels que les sources de données, les fonctionnalités, l’utilisation prévue et toutes les limitations connues pour garantir une compréhension et une utilisation appropriées. Type de données : chaîne
résultat.description	Description de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
result.display_name	Nom d’affichage de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.documentation	Documentation de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
result.managed_by	Détails sur l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [user] Type de données : chaîne
result.name	Nom de l’enregistrement du modèle de produit du jeu de données IA associé. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne
résultat.fournisseur	Fournisseur de l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nom du fournisseur. Type de données : chaîne
result.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model]. Type de données : chaîne
résultat.source	Détails sur la source de l’actif du jeu de données IA. Valeurs valides : Lien vers la source de l’actif de l’ensemble de données. Détails (en texte brut) de la source de l’actif de l’ensemble de données. Par exemple, le nom d’un produit ou d’un site Web. Type de données : chaîne Valeur par défaut : vide ou nul
résultat.état	État de l’enregistrement d’actif du jeu de données IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.sys_id	Sys_id de l’enregistrement d’actif du jeu de données IA. Table : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne
résultat.mis à jour	Date et heure de dernière mise à jour de l’enregistrement d’actif du jeu de données IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.version	Numéro de version de l’enregistrement de modèle de produit du jeu de données IA associé. Par exemple, V2. Type de données : chaîne
résultat.avertissements	Liste séparée par des virgules des messages d’avertissement présents lors de la création de l’ensemble de données. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant montre comment mettre à jour les détails d’un enregistrement d’ensemble de données IA avec un ID donné. Le corps de la demande contient les valeurs de paramètres à mettre à jour.

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

Corps de la réponse.

{ 
  "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": [] 
       } 
}

API des actifs IA : PUT /sn_ent/asset/ai_prompt/{sys_id}

Met à jour les données d’un enregistrement d’actif spécifique de l’invite IA en fonction des informations que vous fournissez dans le corps de la demande.

Voir aussi :

• API des actifs IA : GET /sn_ent/asset/ai_system/{sys_id}
• API des actifs IA : POST /sn_ent/asset/ai_prompt

Remarque :

Fournissez uniquement les paires paramètre-valeur pour les données spécifiques que vous souhaitez mettre à jour. Ce point de terminaison remplace les données pour tous les paramètres envoyés dans la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_prompt/{sys_id}

Paramètres de demande pris en charge

Tableau 55. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif de l’invite IA [alm_ai_prompt_digital_asset]. Type de données : chaîne

Tableau 56. Paramètres de requête

Nom	Description
Néant

Tableau 57. Paramètres de corps de demande (XML ou JSON)

Nom	Description
objet	Requis. Contenu de l’actif de l’invite IA à mettre à jour. Type de données : objet { "ai_model": "String", "description": "String", "documentation": "String", "managed_by": "String" "name": "String", "prompt_info": "String", "provider": "String", "state": Number, "version": "String" }
ai_model	Valeur du champ Modèle IA d’un enregistrement existant dans la table Actif numérique du modèle IA [alm_ai_model_digital_asset]. Valeurs valides : Nom de l’enregistrement d’actif numérique [alm_ai_model_digital_asset] du modèle d’IA Sys_id de l’enregistrement de l’actif numérique du modèle IA [alm_ai_model_digital_asset] Type de données : chaîne Par défaut : chaîne vide
description	Description à donner au modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne Par défaut : chaîne vide
interne	Documentation du modèle de produit de l’invite IA. Type de données : chaîne Par défaut : chaîne vide
managed_by	Valeur du champ Géré par d’un enregistrement existant dans la table Utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Par défaut : chaîne vide
nom	Requis. Nom de l’enregistrement associé dans la table Modèle de produit de l’invite IA [cmdb_ai_prompt_product_model]. Type de données : chaîne Par défaut : chaîne vide
prompt_info	Informations d’invite pour l’actif d’invite IA. Type de données : chaîne Par défaut : chaîne vide
fournisseur	Requis. Valeur du champ Fournisseur d’un enregistrement existant dans la table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
État	État à appliquer à l’actif du modèle IA. Par exemple : Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
version	Numéro de version pour affecter le modèle de produit de l’invite IA. Par exemple, V2. Type de données : chaîne Par défaut : chaîne vide

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 58. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 59. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 60. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

Nom	Description
résultat	result: { "asset": {Object}, "warnings": [Array] }
résultat.actif	Détails sur l’entrée nouvellement créée. Type de données : objet "asset": { "ai_model": Object, "created": "String", "description": "String", "display_name": "String", "documentation": "String", "managed_by": Object, "name": "String", "prompt_info": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
result.asset.ai_model	Liste des modèles IA dans l’enregistrement de la table Actif du système IA [cmdb_ai_ system_asset_model]. Type de données : tableau "ai_model": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.name	Nom de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
result.asset.ai_models.sys_id	Sys_id de l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model] associé. Type de données : chaîne
result.asset.managed_by	Détails sur l’utilisateur qui gère l’actif. Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.nom	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.name	Nom de l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.asset.prompt_info	Informations d’invite de l’enregistrement d’actif de l’invite IA. Type de données : chaîne
résultat.actif.fournisseur	Valeur du champ Fournisseur dans l’enregistrement de table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
result.asset.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
résultat.asset.state	État de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.version	Numéro de version de l’enregistrement de modèle de produit du système IA associé. Par exemple, V2. Type de données : chaîne
résultat.avertissement	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant met à jour les données de l’actif d’invite IA avec le sys_id donné en fonction des valeurs de paramètre indiquées dans le corps de la demande.

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

Corps de la réponse :

{
  "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": []
  }
}

API des actifs IA : PUT /sn_ent/asset/ai_system/{sys_id}

Met à jour les données d’un enregistrement spécifique du système IA en fonction des informations que vous fournissez dans le corps de la demande.

Remarque :

Fournissez uniquement les paires paramètre-valeur pour les données spécifiques que vous souhaitez mettre à jour. Ce point de terminaison remplace les données pour tous les paramètres envoyés dans la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_system/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_system/{sys_id}

Paramètres de demande pris en charge

Tableau 61. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : chaîne

Tableau 62. Paramètres de requête

Nom	Description
Néant

Tableau 63. Paramètres de corps de demande (XML ou JSON)

Nom	Description
objet	Requis. Détails à mettre à jour dans le système IA. Type de données : objet { "name": "String", "description": "String", "provider": "String", "version": "String", "state": Number, "documentation": "String", "ai_models": "String", "ai_prompts": "Strings", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String" }
object.name	Requis. Nom du modèle de produit du système IA. Type de données : chaîne
Objet.description	Description du modèle de produit du système IA. Type de données : chaîne
Fournisseur.objet	Requis. Valeur du champ Fournisseur dans un enregistrement de table Société [core_company]. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
état.objet	État à appliquer à l’actif du système IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne Par défaut : chaîne vide
version.objet	Version du modèle de produit du système IA. Par exemple, V2. Type de données : chaîne Par défaut : chaîne vide
objet.documentation	Documentation de l’actif du système IA. Type de données : chaîne Faire défaut:
object.ai_models	Liste de chaînes séparées par des virgules, où chaque chaîne représente une valeur de champ de modèle IA d’un enregistrement d’actif numérique de modèle IA existant. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Valeurs valides : Nom de l’enregistrement d’actif numérique du modèle d’IA. Sys_id de l’enregistrement de l’actif numérique du modèle IA. Type de données : chaîne Par défaut : chaîne vide
object.evaluation_datasets	Liste séparée par des virgules des jeux de données sur l’IA utilisés pour évaluer l’enregistrement de l’actif du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du système IA [Actif numérique du système IA alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [{String", "String"}] Valeurs valides : Nom de l’enregistrement d’actif numérique du jeu de données IA. Sys_id de l’enregistrement de l’actif numérique du jeu de données IA. Par défaut : chaîne vide
object.evaluation_metrics_report	Référence aux résultats de l’évaluation situés dans le champ de texte de l’enregistrement d’actif du système IA. Par exemple : Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne Par défaut : chaîne vide
object.managed_by	Valeur du champ « Géré par » d’un enregistrement de table d’utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Par défaut : chaîne vide

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 64. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 65. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 66. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. Échec de l’extraction de l’actif avec la sys_id donnée.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Résultats de l’actif du système IA mis à jour. Type de données : objet "result": { "asset": Object, "warnings": [Array] }
résultat.actif	Détails sur l’actif nouvellement créé. Type de données : objet "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
result.ai_models	Liste des modèles IA dans l’enregistrement de la table Actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : tableau "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.ai_models.name	Nom de l’enregistrement d’actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.ai_models.sys_id	Sys_id de l’enregistrement de l’actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
result.ai_prompts	Liste des invites IA dans l’enregistrement d’actif du système IA. Type de données : tableau "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.ai_prompts.name	Nom de l’invite IA. Type de données : chaîne
result.ai_prompts.sys_id	Sys_id de l’enregistrement de l’actif numérique de l’invite IA. Table : Actif numérique de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model] associé. Type de données : chaîne
result.asset.evaluation_datasets	Liste des jeux de données IA utilisés pour évaluer l’enregistrement d’actif du système IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif du système IA [alm_ai_system_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.nom	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.asset.evaluation_datasets.sys_id	Sys_id de l’enregistrement de la table Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset]. Type de données : chaîne
result.asset.evaluation_metrics_report	Résultats de l’évaluation de l’actif du système IA. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.asset.managed_by	Liste séparée par des virgules des sys_ids ou des noms d’affichage des jeux de données IA de l’actif du système IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : objet "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.nom	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.name	Nom de l’enregistrement de modèle de produit du système IA associé. Table : Modèle de produit de système IA [cmdb_ai_system_product_model] Type de données : chaîne
résultat.actif.fournisseur	Valeur du champ Fournisseur dans l’enregistrement de table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : objet provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
result.asset.provider.sys_id	Sys_id du fournisseur dans l’enregistrement de la table Modèle de produit de système IA [cmdb_ai_ system_product_model]. Type de données : chaîne
résultat.asset.state	État de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.version	Numéro de version de l’enregistrement de modèle de produit du système IA associé. Par exemple, V2. Type de données : chaîne
résultat.actif.avertissements	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque la sys_id d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant met à jour le système IA avec des détails à mettre à jour dans le corps de la demande.

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

Le corps de la réponse affiche les résultats de la mise à jour qui a été appliquée au système IA donné sys_id.

{ 
  "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": [] 
  } 
}

API des actifs IA : PUT /sn_ent/asset/ai_model/{sys_id}

Met à jour les données d’un enregistrement d’actif de modèle IA spécifique en fonction des informations que vous fournissez dans le corps de la demande.

Remarque :

Fournissez uniquement les paires paramètre-valeur pour les données spécifiques que vous souhaitez mettre à jour. Ce point de terminaison remplace les données pour tous les paramètres envoyés dans la demande.

Format d'URL

URL versionnée : /api/sn_ent/{api_version}/asset/ai_model/{sys_id}

URL par défaut : /api/sn_ent/asset/ai_model/{sys_id}

Paramètres de demande pris en charge

Tableau 67. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’actif dans la table Actif de l’invite IA [alm_ai_prompt_digital_asset]. Type de données : chaîne

Tableau 68. Paramètres de requête

Nom	Description
Néant

Tableau 69. Paramètres de corps de demande (XML ou JSON)

Nom	Description
objet	Requis. Détails à mettre à jour dans le modèle IA donné. Type de données : objet { "base_model": "String", "context_window": "String", "deployment_guideline": "String", "description": "String", "documentation": "String", "evaluation_datasets": "String", "evaluation_metrics_report": "String", "managed_by": "String", "model_size_in_mb": "String", "model_weights_info": "String", "name": "String", "parameters_info": "String", "provider": "String", "required_infrastructure": "String", "state": Number, "supported_languages": "String", "training_datasets": "String", "training_procedure": "String", "version": "String" }
base_model	Modèle IA à partir duquel cette version de modèle a été dérivée. Remarque : Applicable uniquement aux modèles développés au sein de l’organisation. Type de données : objet { "name": "String", "sys_id": "String" } Valeur par défaut : objet vide
base_model.nom	Nom de l’actif du modèle IA d’après lequel modéliser ce modèle IA. Type de données : chaîne
base_model.sys_id	Sys_id de l’actif du modèle IA à modéliser pour ce modèle IA. Table : actif numérique du modèle d’IA alm_ai_model_digital_asset Type de données : chaîne
context_window	Taille des séquences d’entrée (en d’autres termes, le nombre de jetons) que le modèle peut gérer. Type de données : nombre entier Par défaut : 0
deployment_guideline	Instructions applicables aux modèles développés et déployés au sein d’une organisation. Type de données : chaîne Valeur par défaut : vide
description	Description à donner au modèle d’IA Modèle de produit. Mis à jour dans la table : Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne Valeur par défaut : vide
interne	Documentation de l’enregistrement du modèle de produit de l’invite IA. Table : modèle de produit de l’invite à l’IA [cmdb_ai_model_product_model] Type de données : chaîne Valeur par défaut : vide
evaluation_datasets	Liste séparée par des virgules des sys_ids ou des noms d’affichage des jeux de données IA de l’actif numérique de l’invite IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données sur l’IA [alm_ai_dataset_digital_asset], Actif numérique de l’invite à l’IA [alm_ai_prompt_digital_asset] Type de données : tableau "evaluation_datasets": [ "String", "String" ] Valeurs valides : Nom de l’enregistrement d’actif numérique du jeu de données IA. Sys_id de l’enregistrement de l’actif numérique du jeu de données IA. Par défaut : chaîne vide
evaluation_metrics_report	Référence aux résultats de l’évaluation situés dans le champ de texte de l’enregistrement d’actif du jeu de données IA. Par exemple : Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Table : actif du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne Par défaut : chaîne vide
managed_by	Valeur du champ « Géré par » d’un enregistrement existant dans la table Utilisateur [sys_user]. Valeurs valides : Nom de l’enregistrement de l’utilisateur [sys_user] Sys_id de l’enregistrement de l’utilisateur [sys_user] Type de données : chaîne Valeur par défaut : vide
model_size_in_mb	Taille du modèle en Mo. S’applique principalement aux modèles développés et déployés au sein d’une organisation. Type de données : nombre Valeur par défaut : vide
model_weights_info	Informations supplémentaires sur le modèle, le cas échéant. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : chaîne Valeur par défaut : vide
nom	Requis. Nom du modèle de produit du modèle IA. Mis à jour dans la table : Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
parameters_info	Nombre de paramètres à donner au modèle. Type de données : chaîne Par défaut : chaîne vide
fournisseur	Requis. Valeur du champ « Fournisseur » d’un enregistrement de table Société [core_company]. Affecte ce fournisseur au nouveau modèle d’IA. Valeurs valides : Nom de l’enregistrement de société [core_company] Sys_id de l’enregistrement de la société [core_company] Type de données : chaîne
required_infrastructure	Documentation des besoins en infrastructure pour le déploiement du modèle. Par exemple, des détails sur la pile d’infrastructure et les besoins de traitement. S’applique principalement aux modèles déployés au sein d’une organisation. Type de données : chaîne Valeur par défaut : vide
source	Détails sur la source de qui ou de quoi a créé le modèle. Valeurs valides : Lien vers la source du modèle. Par exemple, https://huggingface.co/mistralai/model1 ou un lien vers Github. Détails de la source en texte brut. Par exemple, Microsoft Azure Type de données : chaîne Valeur par défaut : vide ou nul
État	État à appliquer à l’actif du modèle IA. Valeurs valides : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
supported_languages	Liste séparée par des virgules des langues prises en charge par le modèle IA. Type de données : tableau "supported_languages": [ "String", "String" ] Valeurs valides : Sys_id de l’enregistrement Langue [sys_language] Nom de l’enregistrement de langue [sys_language]. Par exemple, « Français », « Anglais » Par défaut : chaîne vide
training_datasets	Référence à 1+ jeux de données associés utilisés pour la formation du modèle. Liste séparée par des virgules des noms d’sys_ids ou d’affichage de la table Actif du jeu de données IA [alm_ai_dataset_digital_asset]. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : tableau "training_datasets": [ "String", "String" ] Par défaut : chaîne vide
training_procedure	Type de formation à appliquer au modèle IA. Valeurs valides : 1 : Arborescences de décision 2 : Réseaux de neurones profonds 3 : Régression linéaire 4 : Régression logistique 5 : Forêt aléatoire 6 : Apprentissage supervisé 7 : Apprentissage non supervisé 8 : Apprentissage par renforcement 9 : Apprentissage par transfert 10 : Apprentissage semi-supervisé 11 : Affinage des instructions 12 : Mise au point supervisée Type de données : chaîne représentée par un nombre (par exemple, « 3 ») Par défaut : 1 : Arborescences de décision
version	Version du modèle de produit du modèle IA. Par exemple, V2. Type de données : chaîne Valeur par défaut : vide

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 70. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 71. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 72. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
résultat	Résultats de la création de l’actif du modèle IA. Type de données : objet "result": { "asset": Object, "warnings": [Array], }
résultat.actif	Détails sur l’actif du modèle IA créé. Type de données : objet "asset": { "base_model": Object, "context_window": String, "created": "String", "deployment_guideline": String, "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "model_size_in_mb": String, "name": "String", "parameters_info": "String", "provider": Object, "required_infrastructure": String, "state": "String", "source": String, "supported_languages": Array, "sys_id": "String", "training_datasets": Array, "training_procedure": String, "updated": "String", "version": "String" }
result.asset.base_model	Informations sur l’actif du modèle IA d’où provient cette version. Type de données : objet "base_model": { "name": "String", "sys_id": "String" }
result.asset.base_model.name	Nom d’affichage de l’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.base_model.sys_id	Sys_id de l’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.context_window	Taille des séquences d’entrées que le modèle peut gérer. En d’autres termes, le nombre de jetons. Type de données : chaîne représentée par un nombre. Par exemple, « 6000 ».
résultat.actif.créé	Date et heure de création de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
result.asset.deployment_guideline	Instructions applicables aux modèles développés et déployés au sein d’une organisation. Type de données : chaîne
résultat.actif.description	Description de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
result.asset.display_name	Nom d’affichage de l’enregistrement d’actif du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] (champ display_name) Type de données : chaîne
résultat.actif.documentation	Documentation de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
result.asset.evaluation_datasets	Liste séparée par des virgules des noms de sys_ids ou d’affichage des jeux de données IA de l’actif numérique du modèle IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données IA [alm_ai_dataset_digital_asset], Actif numérique du modèle IA [alm_ai_model_digital_asset] Type de données : tableau "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.evaluation_datasets.nom	Nom de l’actif numérique du jeu de données IA. Type de données : chaîne
result.evaluation_datasets.sys_id	Sys_id de l’enregistrement de l’actif numérique du modèle IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.evaluation_metrics_report	Référence aux résultats de l’évaluation. Valeurs possibles : Détails (en texte brut) décrivant les résultats Liens vers des résultats spécifiques Type de données : chaîne
result.asset.managed_by	Utilisateur qui gère l’enregistrement d’actif du modèle IA. Type de données : objet " managed_by": { "name": "String", "sys_id": "String" }
result.asset.managed_by.name	Nom de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.managed_by.sys_id	Sys_id de l’utilisateur qui gère l’enregistrement d’actif du modèle IA. Table : Utilisateur [user] Type de données : chaîne
result.asset.model_size_in_mb	Taille du modèle en Mo. S’applique généralement aux modèles développés et déployés au sein d’une organisation. Type de données : nombre
result.asset.name	Nom de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
résultat.actif.fournisseur	Fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : objet "provider": { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nom du fournisseur. Type de données : chaîne
result.asset.provider.sys_id	Sys_id de l’enregistrement de la table Société [core_company] qui correspond au fournisseur de l’enregistrement du modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne
résultat.actif.source	Détails sur la source de l’actif. Valeurs valides : Lien vers la source du modèle. Par exemple, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 ou un lien vers Github. Détails de la source en texte brut. Par exemple, Microsoft Azure Type de données : chaîne
résultat.asset.state	État de l’enregistrement de l’actif du modèle IA. Valeurs possibles : 1 : En cours d’utilisation 31 : Déployé 32 : Mis hors service 33 : Développement 34 : Inconnu 35 : N. A. Type de données : chaîne
result.asset.supported_languages.name	Nom de la langue prise en charge. Table : Langue [sys_language] Type de données : chaîne
result.asset.supported_languages.sys_id	Sys_id de la langue prise en charge. Table : Langue [sys_language] Type de données : chaîne
result.asset.sys_id	Sys_id de l’enregistrement de l’actif du modèle IA Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] Type de données : chaîne
result.asset.training_datasets	Référence à 1+ ensembles de données associés utilisés pour la formation du modèle. Type de données : tableau "training_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.training_procedure	Type de formation de l’IA appliquée au modèle. Valeurs possibles : 1 : Arborescences de décision 2 : Réseaux de neurones profonds 3 : Régression linéaire 4 : Régression logistique 5 : Forêt aléatoire 6 : Apprentissage supervisé 7 : Apprentissage non supervisé 8 : Apprentissage par renforcement 9 : Apprentissage par transfert 10 : Apprentissage semi-supervisé 11 : Affinage des instructions 12 : Mise au point supervisée Type de données : chaîne
résultat.actif.mis à jour	Date et heure de dernière mise à jour de l’actif du modèle IA. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
résultat.actif.version	Version de l’enregistrement de modèle de produit du modèle IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model table] Type de données : chaîne
result.required_infrastructure	Documentation des besoins en infrastructure pour le déploiement du modèle. Par exemple, des détails sur la pile d’infrastructure et les besoins de traitement. Type de données : chaîne
result.asset.parameters_info	Propriétés des données de formation qui apprennent au cours du processus d’apprentissage. Par exemple : 7B ou 30B. Type de données : chaîne
result.asset.supported_languages	Détails sur les langues prises en charge par l’actif de modèle IA. Table : Langue [sys_language] Type de données : objet "supported_languages": [ { "name": "String", "sys_id": "String" } ]
résultat.avertissements	Liste des messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des vérifications de validation, par exemple lorsque le sysId d’un paramètre facultatif n’est pas valide. Type de données : tableau "warnings": ["String"]

Demande cURL

L’exemple suivant montre comment mettre à jour un modèle d’actif IA donné à l’aide de la méthode PUT.

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

Corps de la réponse.

 { 
  "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" 
    ] 
  } 
}