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 IA, tels que des systèmes, des ensembles de données, des invites et des modèles.
API des actifs IA : GET /sn_ent/asset/ai_dataset/{sys_id}
Récupère les données de l’actif spécifié du jeu de données IA.
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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : actif du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 | 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 |
| result.acceptable_usage.étiquette | Affichez l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne |
| result.acceptable_usage.valeur | L’objectif de l’ensemble de données ou du modèle, par exemple pour la formation ou l’évaluation. Valeurs valides :
Type de données : chaîne (nombre) |
| result.base_datasets | Liste séparée par des virgules des ensembles de données de base requis pour construire l’ensemble de données donné. Accepte le nom ou le 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 |
| résultat.créé | Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : AAAA-MM-JJ 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 |
| 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 ensemble de données d’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 de l’ensemble 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 de l’ensemble 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 |
| 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 de l’ensemble 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 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 : objet |
| result.provider.name | Nom du fournisseur. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_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 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.source | Détails sur la source de l’actif de l’ensemble de données IA. Valeurs valides :
Type de données : chaîne Valeur par défaut : vide ou nul |
| résultat.état | État de l’enregistrement d’actif de l’ensemble de données IA. Valeurs possibles :
Type de données : chaîne |
| result.sys_id | Sys_id de l’enregistrement 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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.version | Numéro de version de l’enregistrement de modèle de produit de l’ensemble 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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif du modèle IA [alm_ai_model_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 de modèle. Type de données : objet |
| 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 Par 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. Table : Actif du modèle IA [alm_ai_model_digital_asset] 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 : AAAA-MM-JJ 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. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] 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 ensembles de données d’IA de l’actif numérique de l’ensemble de données IA utilisé pour évaluer le modèle. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : tableau |
| result.evaluation_metrics_report | Référence aux résultats de l’évaluation. Valeurs possibles :
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 |
| 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. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne |
| result.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 |
| résultat.fournisseur | Fournisseur de l’enregistrement de modèle de produit du jeu de données IA associé. Type de données : objet |
| result.provider.name | Nom du fournisseur. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_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 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.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 |
| result.result.display_name | Nom d’affichage de l’enregistrement de l’actif. Type de données : chaîne |
| résultat.source | Détails sur la source du modèle. Valeurs possibles :
Type de données : chaîne |
| résultat.état | État à appliquer à l’actif du modèle IA. Valeurs possibles :
Type de données : chaîne |
| result.supported_languages | Langues prises en charge par le modèle IA. Type de données : tableau |
| 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 |
| result.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 |
| result.training_procedure | Type d’entraînement IA appliqué au modèle. Valeurs possibles :
Type de données : chaîne |
| résultat.mis à jour | Date et heure de dernière mise à jour de l’actif du modèle IA. Format : AAAA-MM-JJ HH :mm :ss 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 : GET /sn_ent/asset/ai_prompt/{sys_id}
Récupère les données de l’actif d’invite IA spécifié.
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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 | Modèle IA de l’enregistrement d’actif de l’invite IA. Type de données : objet |
| 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 à l’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 Actif de l’invite IA. Format : AAAA-MM-JJ 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 à l’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 |
| result.managed_by.nom | Nom de l’utilisateur qui gère l’enregistrement d’actif. Tables : Utilisateur [sys_user], Invite IA Actif [alm_ai_model_digital_asset] Type de données : chaîne |
| result.managed_by.sys_id | Sys_id de l’enregistrement Utilisateur qui correspond à l’enregistrement Géré par l’utilisateur 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. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : objet |
| result.provider.name | Nom de l’enregistrement de modèle de produit de l’invite IA associé. Table : modèle de produit de l’invite à l’IA [cmdb_ai_prompt_product_model] Type de données : chaîne |
| result.provider.sys_id | Sys_id de l’enregistrement de la table Société qui correspond au fournisseur de l’enregistrement de modèle de produit de l’invite IA associé. 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 :
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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.version | Version de l’enregistrement de modèle de produit associé à l’invite IA. 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 d’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 d’IA spécifié.
Format d'URL
URL avec version : /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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 | Liste des modèles d’IA dans l’enregistrement Actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau |
| 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 Actif du système IA. Type de données : tableau |
| 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. Tableau : Actif numérique de l’invite à l’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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.description | Description de l’enregistrement du modèle de produit du système d’IA associé. Table : Modèle de produit du système IA [cmdb_ai_system_product_model] Type de données : chaîne |
| result.display_name | Nom d’affichage de l’enregistrement 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 du système de produit système d’IA. Table : Produit système IA Système [cmdb_ai_system_product_system] Type de données : chaîne |
| result.evaluation_datasets | Liste des jeux de données d’IA utilisés pour évaluer le modèle dans l’enregistrement d’actif numérique du système d’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 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 d’évaluation de l’enregistrement de l’actif du système d’IA. Valeurs possibles :
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 |
| result.managed_by.nom | Sys_id de l’utilisateur qui gère l’enregistrement de l’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 du modèle de produit du système d’IA associé. Table : Modèle de produit du 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 |
| result.provider.name | Nom du fournisseur dans l’enregistrement de modèle de produit de système IA associé. Table : Modèle de produit du 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 du 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. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Valeurs possibles :
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 : AAAA-MM-JJ 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 d’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 avec version : /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
| 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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| {objet} |
|
| {objet}.acceptable_usage | L’objectif de l’ensemble de données ou du modèle, par exemple pour la formation ou l’évaluation. Valeurs valides :
Type de données : chaîne (nombre) |
| {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 ensembles 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 |
| {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 ensemble de données d’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 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 |
| {objet}.documentation | Documentation pour le modèle de produit du jeu de données IA. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne |
| {objet}.managed_by | Valeur Sys_id ou nom de l’utilisateur dans le champ Géré par de l’enregistrement du modèle de produit du jeu de données IA. Tables : Utilisateur [sys_user], Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] 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 |
| {object}.provider | Requis. Sys_id ou valeur du nom du champ Fournisseur de l’enregistrement de la table 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 :
Type de données : chaîne Valeur par défaut : vide ou nul |
| {objet}.état | État de l’actif de l’ensemble de données IA. Valeurs valides :
Type de données : chaîne |
| {objet}.version | Numéro de version de l’enregistrement de modèle de produit de l’ensemble 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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 | 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 |
| result.acceptable_usage.étiquette | Affichez l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne |
| result.acceptable_usage.valeur | L’objectif de l’ensemble de données ou du modèle, par exemple pour la formation ou l’évaluation. Valeurs valides :
Type de données : chaîne (nombre) |
| result.base_datasets | Liste séparée par des virgules des ensembles de données de base requis pour construire l’ensemble de données donné. Accepte le nom ou le 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 |
| résultat.créé | Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : AAAA-MM-JJ 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 |
| 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 ensemble de données d’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 de l’ensemble 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 de l’ensemble 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 |
| 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 de l’ensemble 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 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 : objet |
| result.provider.sys_id | Sys_id du fournisseur dans 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.provider.name | Nom du fournisseur. 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 de l’ensemble de données IA. Valeurs valides :
Type de données : chaîne Valeur par défaut : vide ou nul |
| résultat.état | État de l’enregistrement d’actif de l’ensemble de données IA. Valeurs possibles :
Type de données : chaîne |
| result.sys_id | Sys_id de l’enregistrement 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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.version | Numéro de version de l’enregistrement de modèle de produit de l’ensemble 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 du jeu 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 |
Demande cURL
L’exemple suivant montre comment créer un 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 d’invite IA dans les tables Actif numérique de l’invite IA [alm_ai_prompt_digital_asset] et Modèle de produit de l’invite IA [cmdb_ai_promt_product_model] en fonction des détails que vous fournissez dans le corps de la demande.
Format d'URL
URL avec version : /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
| 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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| objet | Requis. Contenu de l’actif de l’invite IA à mettre à jour. Type de données : objet |
| ai_model | Nom de sys_id valeur du champ du modèle IA dans 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 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 |
| documentation | Documentation 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 Par défaut : chaîne vide |
| managed_by | Nom ou sys_id de l’utilisateur qui gère l’actif. Situé dans le champ Géré par de l’enregistrement de l’actif. Onglet; e : 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 [cmdb_ai_prompt_product_model] de l’invite IA. Type de données : chaîne Par défaut : chaîne vide |
| prompt_info | Informations d’invite pour l’actif de l’invite IA. Type de données : chaîne Par défaut : chaîne vide |
| fournisseur | Requis. Nom du fournisseur ou sys_id de l’enregistrement de table Société. Table : Société [core_company] Type de données : chaîne |
| État | État à appliquer à l’actif du modèle IA. Par exemple : Valeurs valides :
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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 |
| résultat.actif | Détails sur l’entrée nouvellement créée. Type de données : objet |
| result.asset.ai_model | Liste des modèles IA dans l’enregistrement de la table Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau |
| result.asset.ai_models.nom | 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.asset.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.asset.ai_prompts | Liste des invites IA 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 : tableau |
| 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 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 |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 d’IA associé. Table : Modèle de produit du système IA [cmdb_ai_system_product_model] Type de données : chaîne |
| result.asset.display_name | Nom d’affichage 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.documentation | Documentation 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.evaluation_datasets | Liste des noms de sys_ids ou d’affichage des ensembles de données d’IA utilisés pour évaluer le modèle d’actif du système d’IA. S’applique principalement aux modèles développés au sein d’une organisation. Tables : Actif numérique du jeu de données d’IA [alm_ai_dataset_digital_asset], Actif numérique du système d’IA [alm_ai_system_digital_asset] Type de données : tableau |
| 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 d’évaluation de l’actif du système d’IA. Valeurs possibles :
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 |
| 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 du modèle de produit du système d’IA associé. Table : Modèle de produit du 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 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 : objet |
| result.asset.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.asset.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.actif.état | État de l’actif du modèle IA. Valeurs possibles :
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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.avertissement | Liste de 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 |
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 d’IA dans les tables Actif numérique du modèle d’IA [alm_ai_model_digital_asset] et Modèle de produit du modèle d’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
| 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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| {objet} | Requis. Détails à appliquer au nouvel enregistrement de modèle d’actif. Type de données : objet |
| {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 |
| {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 d’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 d’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 ensembles de données d’IA des ensembles de données d’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 Valeurs valides :
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 :Table : actif numérique du modèle d’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 :
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, si disponibles. 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 |
| {object}.provider | Requis. Sys_id ou nom de l’utilisateur auquel affecter le champ Fournisseur dans l’enregistrement du modèle de produit du modèle IA. Table : 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 la personne ou de l’objet qui a créé le modèle. Valeurs valides :
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 :
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 Valeurs valides :
Par défaut : chaîne vide |
| {objet}.training_datasets | Ensembles de données utilisés pour entraîner le modèle IA. Liste de noms d’sys_ids ou d’affichage séparés par des virgules de la table Actif [alm_ai_dataset_digital_asset] de l’ensemble de données IA. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : tableau Par défaut : chaîne vide |
| {objet}.training_procedure | Numéro indiquant le type de formation à appliquer au modèle IA. Valeurs valides :
Type de données : chaîne représentée par un nombre (par exemple, 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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 201 | Réussi. La demande a été traitée avec succès. |
| 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 ressource du modèle IA. Type de données : objet |
| résultat.actif | Détails sur l’actif du modèle IA créé. Type de données : objet |
| result.asset.base_model | Informations sur l’actif du modèle IA d’où cette version est dérivée. Type de données : objet |
| 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, |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 de l’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 d’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 | Ensembles de données d’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 numérique du modèle IA [alm_ai_model_digital_asset] Type de données : tableau |
| result.evaluation_datasets.nom | Nom de l’actif numérique du jeu de données IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] 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 :
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 |
| 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 d’IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : objet |
| result.asset.provider.name | Nom de l’enregistrement de société qui correspond au fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Tables : Société [core_company], Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne |
| result.asset.provider.sys_id | Sys_id de l’enregistrement de société qui correspond au fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Tables : Société [core_company], 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 :
Type de données : chaîne |
| résultat.actif.état | État de l’enregistrement de l’actif du modèle IA. Valeurs possibles :
Type de données : chaîne |
| result.asset.supported_languages.nom | 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 |
| result.asset.training_procedure | Valeur numérique indiquant le type d’entraînement de l’IA appliqué au modèle. Valeurs possibles :
Type de données : chaîne représentée par un nombre |
| résultat.actif.mis à jour | Date et heure de dernière mise à jour de l’actif du modèle IA. Format : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.actif.version | Version de l’enregistrement du modèle de produit du modèle d’IA associé. Table : modèle de produit du modèle IA [table cmdb_ai_model_product_model] 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 |
| result.asset.supported_languages.nom | Nom de la langue prise en charge par l’actif. Table : Langue [sys_language] Type de données : chaîne |
| result.asset.supported_languages.sys_id | Sys_id de la langue prise en charge par la ressource. Table : Langue [sys_language] Type de données : chaîne |
| résultat.avertissements | Liste de messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque le sysId d’un paramètre facultatif n’est pas valide. Type de données : tableau |
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"
}'
{
"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 du système d’IA dans les tables Actif numérique du système d’IA [alm_ai_system_digital_asset] et Modèle de produit du système d’IA [cmdb_ai_system_product_model] en fonction des détails que vous fournissez dans le corps de la demande.
Format d'URL
URL avec version : /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
| 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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| objet | Requis. Détails à mettre à jour dans le système d’IA. Type de données : objet |
| 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 |
| object.provider | Requis. Sys_id ou valeur du nom du champ Fournisseur de l’enregistrement de la table Société [core_company]. Type de données : chaîne |
| Objet.État | État à appliquer à l’actif du système IA. Valeurs valides :
Type de données : chaîne Par défaut : chaîne vide |
| Objet.version | 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 Par défaut : |
| object.ai_models | Liste de noms ou d’sys_ids séparés par des virgules de l’enregistrement de l’actif numérique du modèle IA, 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] Type de données : tableau de chaînes Par défaut : chaîne vide |
| object.evaluation_datasets | Liste de noms ou d’sys_ids séparés 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 de chaînes Par défaut : chaîne vide |
| object.evaluation_metrics_report | Référence aux résultats de l’évaluation située dans le champ de texte de l’enregistrement d’actif du système d’IA. Par exemple :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 | Sys_id ou nom du champ « Géré par » d’un enregistrement existant de la table 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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 d’IA. Type de données : objet |
| résultat.actif | Détails sur l’entrée nouvellement créée. Type de données : objet |
| result.asset.ai_models | Liste des modèles d’IA dans l’enregistrement Actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau |
| result.asset.ai_models.nom | 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.asset.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.asset.ai_prompts | Liste des invites IA de l’enregistrement de l’actif numérique du système IA [alm_ai_system_digital_asset]. Type de données : tableau |
| 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 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 |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 d’IA associé. Table : Modèle de produit du système IA [cmdb_ai_system_product_model] Type de données : chaîne |
| result.asset.display_name | Nom d’affichage 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.documentation | Documentation pour 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.evaluation_datasets | Liste des jeux de données d’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 |
| result.asset.evaluation_datasets.nom | Nom 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.asset.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.asset.evaluation_metrics_report | Résultats d’évaluation de l’actif du système d’IA. Valeurs possibles :
Type de données : chaîne |
| result.asset.managed_by | Liste séparée par des virgules des noms de sys_ids ou d’affichage des ensembles de données d’IA du système IA Actif 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 |
| 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 du modèle de produit du système d’IA associé. Table : Modèle de produit du 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 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 |
| result.asset.provider.name | Nom du fournisseur dans l’enregistrement de modèle de produit de système IA associé. Table : Modèle de produit système [cmdb_ai_ system_product_model] Type de données : chaîne |
| result.asset.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 système [cmdb_ai_ system_product_model] Type de données : chaîne |
| résultat.actif.état | État de l’actif du modèle IA. Valeurs possibles :
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 : AAAA-MM-JJ 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 d’IA associé. Par exemple, V2.Type de données : chaîne |
| résultat.actif.avertissements | Liste de 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 |
Demande cURL
L’exemple suivant insère une nouvelle entrée dans les tables Actif numérique du système d’IA et Modèle de produit du système d’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 d’ensemble de données d’IA spécifique en fonction des informations que vous fournissez dans le corps de 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 d’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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : actif du jeu de données IA [alm_ai_dataset_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| {objet} |
|
| {objet}.acceptable_usage | L’objectif de l’ensemble de données ou du modèle, par exemple pour la formation ou l’évaluation. Valeurs valides :
Type de données : chaîne (nombre) |
| {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 ensembles 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 |
| {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 ensemble de données d’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 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 |
| {objet}.documentation | Documentation pour le modèle de produit du jeu de données IA. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] Type de données : chaîne |
| {objet}.managed_by | Valeur Sys_id ou nom de l’utilisateur dans le champ Géré par de l’enregistrement du modèle de produit du jeu de données IA. Tables : Utilisateur [sys_user], Modèle de produit du jeu de données IA [cmdb_ai_dataset_product_model] 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 |
| {object}.provider | Requis. Sys_id ou valeur du nom du champ Fournisseur de l’enregistrement de la table 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 :
Type de données : chaîne Valeur par défaut : vide ou nul |
| {objet}.état | État de l’actif de l’ensemble de données IA. Valeurs valides :
Type de données : chaîne |
| {objet}.version | Numéro de version de l’enregistrement de modèle de produit de l’ensemble 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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 | 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 |
| result.acceptable_usage.étiquette | Affichez l’étiquette de la valeur d’utilisation acceptable. Type de données : chaîne |
| result.acceptable_usage.valeur | L’objectif de l’ensemble de données ou du modèle, par exemple pour la formation ou l’évaluation. Valeurs valides :
Type de données : chaîne (nombre) |
| result.base_datasets | Liste séparée par des virgules des ensembles de données de base requis pour construire l’ensemble de données donné. Accepte le nom ou le 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 |
| résultat.créé | Date et heure de création de l’enregistrement d’actif du jeu de données IA. Format : AAAA-MM-JJ 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 |
| 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 ensemble de données d’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 de l’ensemble 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 de l’ensemble 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 |
| 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 de l’ensemble 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 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 : objet |
| result.provider.name | Nom du fournisseur. Table : modèle de produit du jeu de données IA [cmdb_ai_dataset_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 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.source | Détails sur la source de l’actif de l’ensemble de données IA. Valeurs valides :
Type de données : chaîne Valeur par défaut : vide ou nul |
| résultat.état | État de l’enregistrement d’actif de l’ensemble de données IA. Valeurs possibles :
Type de données : chaîne |
| result.sys_id | Sys_id de l’enregistrement 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 : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.version | Numéro de version de l’enregistrement de modèle de produit de l’ensemble 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 du jeu 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 |
Demande cURL
L’exemple suivant montre comment mettre à jour les détails d’un enregistrement d’ensemble de données d’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.
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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| objet | Requis. Contenu de l’actif de l’invite IA à mettre à jour. Type de données : objet |
| ai_model | Nom de sys_id valeur du champ du modèle IA dans 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 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 |
| documentation | Documentation 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 Par défaut : chaîne vide |
| managed_by | Nom ou sys_id de l’utilisateur qui gère l’actif. Situé dans le champ Géré par de l’enregistrement de l’actif. Onglet; e : 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 [cmdb_ai_prompt_product_model] de l’invite IA. Type de données : chaîne Par défaut : chaîne vide |
| prompt_info | Informations d’invite pour l’actif de l’invite IA. Type de données : chaîne Par défaut : chaîne vide |
| fournisseur | Requis. Nom du fournisseur ou sys_id de l’enregistrement de table Société. Table : Société [core_company] Type de données : chaîne |
| État | État à appliquer à l’actif du modèle IA. Par exemple : Valeurs valides :
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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 |
|
| résultat.actif | Détails sur l’entrée nouvellement créée. Type de données : objet |
| result.asset.ai_model | Liste des modèles IA dans l’enregistrement de la table Actif du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau |
| result.asset.ai_models.nom | 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.asset.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 |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 d’IA associé. Table : Modèle de produit du système IA [cmdb_ai_system_product_model] Type de données : chaîne |
| result.asset.display_name | Nom d’affichage 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.documentation | Documentation 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.managed_by | Détails sur l’utilisateur qui gère l’actif. Type de données : objet |
| 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 du modèle de produit du système d’IA associé. Table : Modèle de produit du 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 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 : objet |
| result.asset.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.asset.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.actif.état | État de l’actif du modèle IA. Valeurs possibles :
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 : AAAA-MM-JJ 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 d’IA associé. Par exemple, V2.Type de données : chaîne |
| résultat.avertissement | Liste de 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 |
Demande cURL
L’exemple suivant met à jour les données de l’actif Invite IA avec le sys_id donné en fonction des valeurs de paramètres fournies 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 de système d’IA spécifique en fonction des informations que vous fournissez dans le corps de la demande.
Format d'URL
URL avec version : /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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| objet | Requis. Détails à mettre à jour dans le système d’IA. Type de données : objet |
| 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 |
| object.provider | Requis. Sys_id ou valeur du nom du champ Fournisseur de l’enregistrement de la table Société [core_company]. Type de données : chaîne |
| Objet.État | État à appliquer à l’actif du système IA. Valeurs valides :
Type de données : chaîne Par défaut : chaîne vide |
| Objet.version | 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 Par défaut : |
| object.ai_models | Liste de noms ou d’sys_ids séparés par des virgules de l’enregistrement de l’actif numérique du modèle IA, 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] Type de données : tableau de chaînes Par défaut : chaîne vide |
| object.evaluation_datasets | Liste de noms ou d’sys_ids séparés 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 de chaînes Par défaut : chaîne vide |
| object.evaluation_metrics_report | Référence aux résultats de l’évaluation située dans le champ de texte de l’enregistrement d’actif du système d’IA. Par exemple :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 | Sys_id ou nom du champ « Géré par » d’un enregistrement existant de la table 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 uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le sys_id donné. |
| 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 |
| résultat.actif | Détails sur l’actif nouvellement créé. Type de données : objet |
| result.ai_models | Liste des modèles d’IA dans l’enregistrement Actif numérique du système IA. Table : Actif numérique du système IA [alm_ai_system_digital_asset] Type de données : tableau |
| 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 Actif du système IA. Type de données : tableau |
| 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. Tableau : Actif numérique de l’invite à l’IA [alm_ai_prompt_digital_asset] Type de données : chaîne |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 d’IA associé. Table : Modèle de produit du système IA [cmdb_ai_system_product_model] Type de données : chaîne |
| result.asset.display_name | Nom d’affichage 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.documentation | Documentation pour 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.evaluation_datasets | Liste des jeux de données d’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 |
| result.asset.evaluation_datasets.nom | Nom 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.asset.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.asset.evaluation_metrics_report | Résultats d’évaluation de l’actif du système d’IA. Valeurs possibles :
Type de données : chaîne |
| result.asset.managed_by | Liste séparée par des virgules des noms de sys_ids ou d’affichage des ensembles de données d’IA du système IA Actif 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 |
| 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 du modèle de produit du système d’IA associé. Table : Modèle de produit du 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 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 |
| result.asset.provider.name | Nom du fournisseur dans l’enregistrement de modèle de produit de système IA associé. Table : Modèle de produit système [cmdb_ai_ system_product_model] Type de données : chaîne |
| result.asset.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 système [cmdb_ai_ system_product_model] Type de données : chaîne |
| résultat.actif.état | État de l’actif du modèle IA. Valeurs possibles :
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 : AAAA-MM-JJ 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 d’IA associé. Par exemple, V2.Type de données : chaîne |
| résultat.actif.avertissements | Liste de 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 |
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 d’IA sys_id donné.
{
"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.
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
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de l’actif. Table : Actif de l’invite IA [alm_ai_prompt_digital_asset] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| objet | Requis. Détails à mettre à jour dans le modèle d’IA donné. Type de données : 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 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. Table : actif numérique du modèle d’IA alm_ai_model_digital_asset 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 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 Par défaut : vide |
| 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 Par défaut : vide |
| evaluation_datasets | Liste séparée par des virgules des sys_ids ou des noms d’affichage des ensembles de données d’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 IA [alm_ai_dataset_digital_asset], Actif numérique de l’invite IA [alm_ai_prompt_digital_asset] Type de données : tableau Valeurs valides :
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 :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 | Sys_id ou nom de l’utilisateur dans le champ « Géré par » de l’enregistrement d’actif du jeu de données IA. Table : Utilisateur [sys_user] Type de données : chaîne 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 Par défaut : vide |
| model_weights_info | Informations supplémentaires sur le modèle, si disponibles. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : chaîne 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. Sys_id ou valeur de nom du champ « Fournisseur » d’un enregistrement de table de société [core_company]. Affecte ce fournisseur au nouveau modèle d’IA. 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 Par défaut : vide |
| source | Détails sur la source de la personne ou de l’objet qui a créé le modèle. Valeurs valides :
Type de données : chaîne Valeur par défaut : vide ou nul |
| État | État à appliquer à l’actif du modèle IA. Valeurs valides :
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 Valeurs valides :
Par défaut : chaîne vide |
| training_datasets | Référence à 1+ ensembles de données associés utilisés pour la formation du modèle. Liste de noms d’sys_ids ou d’affichage séparés par des virgules de la table Actif [alm_ai_dataset_digital_asset] de l’ensemble de données IA. S’applique principalement aux modèles développés au sein d’une organisation. Type de données : tableau Par défaut : chaîne vide |
| training_procedure | Type d’entraînement à appliquer au modèle d’IA. Valeurs valides :
Type de données : chaîne représentée par un nombre (par exemple, 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 Par défaut : vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Résultats de la création de ressource du modèle IA. Type de données : objet |
| résultat.actif | Détails sur l’actif du modèle IA créé. Type de données : objet |
| result.asset.base_model | Informations sur l’actif du modèle IA d’où cette version est dérivée. Type de données : objet |
| 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, |
| résultat.actif.créé | Date et heure de création du modèle d’IA. Format : AAAA-MM-JJ 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 de l’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 d’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 | Ensembles de données d’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 numérique du modèle IA [alm_ai_model_digital_asset] Type de données : tableau |
| result.evaluation_datasets.nom | Nom de l’actif numérique du jeu de données IA. Table : Actif numérique du modèle d’IA [alm_ai_model_digital_asset] 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 :
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 |
| 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 d’IA associé. Table : modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : objet |
| result.asset.provider.name | Nom de l’enregistrement de société qui correspond au fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Tables : Société [core_company], Modèle de produit du modèle IA [cmdb_ai_model_product_model] Type de données : chaîne |
| result.asset.provider.sys_id | Sys_id de l’enregistrement de société qui correspond au fournisseur de l’enregistrement de modèle de produit du modèle IA associé. Tables : Société [core_company], 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 :
Type de données : chaîne |
| résultat.actif.état | État de l’enregistrement de l’actif du modèle IA. Valeurs possibles :
Type de données : chaîne |
| result.asset.supported_languages.nom | 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 |
| result.asset.training_procedure | Valeur numérique indiquant le type d’entraînement de l’IA appliqué au modèle. Valeurs possibles :
Type de données : chaîne représentée par un nombre |
| résultat.actif.mis à jour | Date et heure de dernière mise à jour de l’actif du modèle IA. Format : AAAA-MM-JJ HH :mm :ss Type de données : chaîne |
| résultat.actif.version | Version de l’enregistrement du modèle de produit du modèle d’IA associé. Table : modèle de produit du modèle IA [table cmdb_ai_model_product_model] 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 |
| result.asset.supported_languages.nom | Nom de la langue prise en charge par l’actif. Table : Langue [sys_language] Type de données : chaîne |
| result.asset.supported_languages.sys_id | Sys_id de la langue prise en charge par la ressource. Table : Langue [sys_language] Type de données : chaîne |
| résultat.avertissements | Liste de messages d’avertissement séparés par des virgules. Ces avertissements peuvent être des contrôles de validation, par exemple lorsque le sysId d’un paramètre facultatif n’est pas valide. Type de données : tableau |
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"
]
}
}