API de ativos de IA

Ativos de IA A API fornece endpoints para recuperar, atualizar e criar vários tipos de ativos de IA, como sistemas, conjuntos de dados, prompts e modelos.

. Ativos de IA A API oferece suporte a ações que você pode executar nos registros de ativos de IA na aplicação Modelo expandido e Classes de ativo. É necessário o plug-in Classes de ativo (sn_ent) para acessá-lo. Você deve ter as funções asset e model_manager para chamar os endpoints fornecidos pela API de ativos de IA.

Nota:

Os dados incluídos nos registros de ativos de IA podem ser distribuídos em várias tabelas, como modelo de produto, item de configuração e outras. Para reduzir a complexidade ao chamar esta API, no entanto, o. Ativos de IA A API insere dados somente nas tabelas Ativo, Modelo de produto e Item de configuração. As especificações sobre atualizações de tabela são fornecidas em cada endpoint.

API de ativos de IA - OBTER /sn_ent/asset/ai_dataset/(sys_id)

Recupera os dados do ativo do conjunto de dados de IA especificado.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_dataset/sys_id

URL padrão: /api/sn_ent/asset/ai_dataset/

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 6. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
resultado	Detalhes do ativo do conjunto de dados de IA recém-criado. Tipo de dados: Objeto "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
acceptable_usage	Uso aceitável para o registro de ativo do conjunto de dados de IA. O uso aceitável se refere a como um conjunto de dados ou modelo pode ser usado, normalmente para fins de treinamento ou avaliação. Tipo de dados: Objeto "acceptable_usage": { "label": "String" "value": "String" }
label.acceptable_usage.label	Rótulo de exibição do valor de uso aceitável. Tipo de dados: Cadeia de caracteres
valor.acceptable_usage.value	Valor numérico do uso aceitável. Valores válidos: 1: Treinamento 2: Avaliação Tipo de dados: Cadeia de caracteres
result.base_datasets	Lista separada por vírgulas de conjuntos de dados base necessários para criar o conjunto de dados fornecido. Aceita o nome ou o sys_id de um conjunto de dados de base na tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Matriz "base_datasets": ["String", "String"]
resultado.criado	Data e hora em que o registro de ativo do conjunto de dados de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.data_type	O tipo de dados presentes no registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "data_type": { "label": "String", "value": "String" }
resultado.data_type.label	O rótulo de exibição do valor do tipo de dados. Tipo de dados: Cadeia de caracteres
valor.data_type.value	Valor do tipo de dados do ativo do conjunto de dados. Tipo de dados: Cadeia de caracteres
dataset_card.dataset_card	O cartão do conjunto de dados. Um dataset_card é um documento de metadados que descreve o conteúdo, a estrutura e o contexto de um conjunto de dados de IA. Ele fornece detalhes como fontes de dados, recursos, uso pretendido e quaisquer limitações conhecidas para garantir a compreensão e o uso adequados. Tipo de dados: Cadeia de caracteres
result.description	Descrição do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
display_name.display_name	Nome de exibição do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Detalhes sobre o usuário que gerencia o registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.name	Nome do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	SYS_id do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.name	Nome do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
result.provider	Provedor do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
result.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
origem.resultado	Detalhes sobre a origem do ativo do conjunto de dados de IA. Valores válidos: Link para a origem do ativo do conjunto de dados. Detalhes (em texto simples) da origem do ativo do conjunto de dados. Por exemplo, o nome de um produto ou site. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
estado.resultado	Estado do registro de ativo do conjunto de dados de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	SYS_id do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.atualizado	Data e hora em que o registro de ativo do conjunto de dados de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.versão	Número da versão do registro do modelo de produto do conjunto de dados de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir.

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

Saída:

{ 
  "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 de ativos de IA - OBTER /sn_ent/asset/ai_model/(sys_id)

Recupera os dados do ativo do modelo de IA especificado.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_model/sys_id

URL padrão: /api/sn_ent/asset/ai_model/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do modelo de IA [alm_ai_model_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 10. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 12. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

resultado	Detalhes do registro de ativo do modelo. Tipo de dados: Objeto result: { "base_model": {Object}, "context_window": "String", "created": "String", "deployment_guideline": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": {Object}, "model_size_in_mb": "String", "name": "String", "parameters_info": "String", "provider": {Object}, "required_infrastructure": "String", "source": "String", "state": Number, "supported_languages": [Array], "sys_id": "String", "training_datasets": [Array], "training_procedure": "String", "updated": "String", "version": "String" }
resultado.base_model	Modelo de IA do qual esta versão do modelo foi derivada. Nota: Aplicável somente a modelos desenvolvidos na organização. Tipo de dados: Objeto { "name": "String", "sys_id": "String" } Padrão:
result.base_model.name	Nome do ativo do modelo de IA para modelar este modelo de IA após. Tipo de dados: Cadeia de caracteres
resultado.base_model.sys_id	SYS_id do ativo do modelo de IA para modelar este modelo de IA após. Tipo de dados: Cadeia de caracteres
context_window.result.context	Tamanho das sequências de entrada (em outras palavras, o número de tokens) que o modelo pode manipular. Tipo de dados: Cadeia de caracteres representada com um número
resultado.criado	Data e hora em que o registro de ativo do conjunto de dados de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.deployment_guideline	Instruções aplicáveis a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Cadeia de caracteres
result.description	Descrição para fornecer o modelo de produto do modelo de IA. Atualizado na tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.result.display_name	Nome de exibição do registro do ativo. Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro do modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.evaluation_datasets	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo digital do conjunto de dados de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ "name": "String", "sys_id": "String" ]
evaluation_metrics_report	Referência aos resultados da avaliação. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Detalhes sobre o usuário que gerencia o registro de ativo do modelo de IA. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.name	Nome do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	SYS_id do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
model_size_in_mb.model_size_in_mb	Tamanho do modelo em MB. Aplicável principalmente a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Número
result.name	Necessário. Nome do modelo de produto do modelo de IA. Atualizado na tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.provider	Provedor do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
result.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
result.required_infrastructure	Documentação das necessidades de infraestrutura para a implantação do modelo. Por exemplo, detalhes sobre a pilha de infraestrutura e as necessidades de processamento. Aplicável principalmente a modelos implantados em uma organização. Tipo de dados: Cadeia de caracteres
origem.resultado	Detalhes sobre a origem do modelo. Valores possíveis: Link para a origem do modelo. Por exemplo, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Ou um link para o Github. Detalhes da origem em texto simples. Por exemplo, Microsoft Azure Tipo de dados: Cadeia de caracteres
estado.resultado	Estado a ser aplicado ao ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
supported_languages	Idiomas compatíveis com o modelo de IA. Tipo de dados: Matriz "supported_languages": [ { "name": "String", "sys_id": "String" } ]
result.supported_languages.name	Nome do registro de idioma. Por exemplo, "Francês", "Inglês" . Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
supported_languages.sys_id	Sys_id do registro de idioma. Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do registro de ativo do modelo de IA. Tabela: Ativo do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.versão	Versão do modelo de produto do modelo de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir.

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

Saída:

{
  "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 de ativos de IA - OBTER /sn_ent/asset/ai_prompt/(sys_id)

Recupera os dados do ativo de prompt de IA especificado.

Consulte também:

• API de ativos de IA - POST /sn_ent/asset/ai_prompt
• API de ativos de IA - COLOQUE /sn_ent/asset/ai_prompt/(sys_id)

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_prompt/sys_id

URL padrão: /api/sn_ent/asset/ai_prompt/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do prompt de IA [alm_ai_prompt_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 18. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
resultado	Detalhes sobre o ativo de prompt de IA. result: { "ai_model": {Object}, "created": "String", "description": "String", "display_name": "String", "documentation": "String", "managed_by": {Object}, "name": "String", "prompt_info": "String", "provider": {Object}, "state": Number, "sys_id": "String", "updated": "String", "version": "String" }
resultado.ai_model	Modelo de IA do registro de ativo do prompt de IA. Tipo de dados: Objeto "ai_model": { "name": "String", "sys_id": "String" }
result.ai_model.name	Nome do modelo de IA. Tipo de dados: Cadeia de caracteres
resultado.ai_model.sys_id	SYS_id do registro do modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.criado	Data e hora em que o registro de ativo de prompt de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.description	Descrição do registro do modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres
display_name.display_name	Nome de exibição do registro de ativo de prompt de IA associado. Tabela: Ativo de prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro do modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Usuário que gerencia o registro de ativo do prompt de IA. Tipo de dados: Objeto "managed_by": { "name": "String", "sys_id": "String" }
result.managed_by.name	Nome do usuário que gerencia o registro de ativo. Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	Sys_id do registro de usuário que corresponde ao gerenciado pelo usuário do registro de ativo. Tabelas: Usuário [sys_user], Ativo de prompt de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
result.name	Nome do modelo de produto de prompt de IA associado. Tabela: Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres
result.prompt_info	Solicitar informações do registro de ativo de prompt de IA. Tabela: Ativo de prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Cadeia de caracteres
result.provider	Provedor do registro do modelo de produto do prompt de IA. "provider": { "name": "String", "sys_id": "String" } Tipo de dados: Objeto
result.provider.name	Nome do registro do modelo de produto do prompt de IA associado. Tipo de dados: Cadeia de caracteres
result.provider.sys_id	Sys_id do registro da tabela Empresa [core_company] que corresponde ao provedor do registro do modelo de produto do prompt de IA associado. Tabelas: Empresa [core_company], Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres
estado.resultado	Estado do registro de ativo do prompt de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	SYS_id do registro de ativo do prompt de IA. Tabela: Ativo de prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.atualizado	Data e hora em que o registro de ativo de prompt de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.versão	Versão do registro do modelo de produto do prompt de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir mostra como recuperar informações sobre um modelo de ativo de prompt de IA usando um ID específico.

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

O corpo da resposta retorna detalhes sobre o modelo de ativo de prompt específico que foi recuperado.

{
  "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 de ativos de IA - OBTER /sn_ent/asset/ai_system/sys_id

Recupera os dados do ativo do sistema de IA especificado.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_system/sys_id

URL padrão: /api/sn_ent/asset/ai_system/

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 24. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
resultado	Detalhes sobre o ativo recuperado do sistema de IA. result: { "ai_models": [Array], "ai_prompts": [Array], "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": Number, "sys_id": "String", "updated": "String", "version": "String" }
resultado.ai_models	Lista de modelos de IA no registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Matriz "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.ai_models.name	Nome do registro de ativo digital do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.ai_models.sys_id	SYS_id do registro de ativo digital do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ai_prompts	Lista de prompts de IA no registro de ativo do sistema de IA. Tipo de dados: Matriz "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.ai_prompts.name	Nome do prompt de IA. Tipo de dados: Cadeia de caracteres
ai_prompts.sys_id	SYS_id do registro de ativo digital do prompt de IA. Tabela: Ativo digital do prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.criado	Data e hora em que o ativo do sistema de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.description	Descrição do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
display_name.display_name	Nome de exibição do registro de ativo do sistema de IA. Tabela: Ativo do sistema de IA [cmdb_ai_ system_asset_model] Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro do sistema de produto do sistema de IA. Tabela: Sistema de produto do sistema de IA [cmdb_ai_system_product_system] Tipo de dados: Cadeia de caracteres
result.evaluation_datasets	Lista de conjuntos de dados de IA usados para avaliar o modelo no registro de ativo digital do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ] Padrão: Cadeia de caracteres vazia
result.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.evaluation_datasets.sys_id	SYS_id do registro de ativo digital do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
evaluation_metrics_report	Resultados da avaliação do registro de ativos do sistema de IA. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Detalhes sobre o usuário que gerencia o registro de ativo do sistema de IA. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.name	Sys_id do usuário que gerencia o registro de ativo do sistema de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	Nome do usuário que gerencia o registro de ativo do sistema de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.name	Nome do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.provider	Valor do campo Provedor no registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nome do provedor no registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.provider.sys_id	Sys_id do provedor no registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
estado.resultado	Estado do registro de ativo do sistema de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.atualizado	Data e hora em que o ativo do sistema de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.versão	Número da versão do registro do modelo de produto do sistema de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir mostra como recuperar um ativo de modelo de sistema de IA com um determinado ID.

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

O corpo da resposta retorna detalhes sobre o ativo do modelo do sistema de IA fornecido.

{
  "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 de ativos de IA - POST /sn_ent/asset/ai_dataset

Cria uma nova entrada de ativo do conjunto de dados de IA no Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] e no modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] de acordo com os detalhes fornecidos no corpo da solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent//asset/ai_dataset

URL padrão: /api/sn_ent/asset/ai_dataset

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
(objeto)	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
(objeto)	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
(objeto).acceptable_usage	Determina como um conjunto de dados ou modelo pode ser usado, normalmente para fins de treinamento ou avaliação. Valores válidos: 1: Treinamento 2: Avaliação Tipo de dados: Cadeia de caracteres
(objeto).base_datasets	Lista separada por vírgulas de conjuntos de dados base necessários para criar este conjunto de dados. Aceita nomes ou sys_ids de conjuntos de dados presentes na tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Matriz “base_datasets”: [ “String”, “String”]
(objeto).data_type	Tipo de dados presentes no conjunto de dados. Por exemplo, Texto, Vídeo, Imagem ou 1,2 . Tipo de dados: Cadeia de caracteres
(objeto).dataset_card	O cartão do conjunto de dados. Um dataset_card é um documento de metadados que descreve o conteúdo, a estrutura e o contexto de um conjunto de dados de IA. Ele fornece detalhes como fontes de dados, recursos, uso pretendido e quaisquer limitações conhecidas para garantir a compreensão e o uso adequados. Tipo de dados: Cadeia de caracteres
descrição.objeto	Descrição do registro associado na tabela Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
(objeto).documentação	Documentação do modelo de produto do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
(objeto).managed_by	Valor do campo Gerenciado por de um registro de tabela de Usuário [sys_user] existente. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres
(objeto).nome	Necessário. Nome do registro associado na tabela Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
(objeto).provedor	Necessário. Valor do campo Provedor de um registro existente na tabela Empresa [core_company]. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
(objeto).origem	Detalhes sobre a origem do conjunto de dados. Valores válidos: Link para a origem do conjunto de dados. Detalhes da origem em texto simples. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
(objeto).estado	Estado do ativo do conjunto de dados de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
(objeto).versão	Número da versão do registro do modelo de produto do conjunto de dados de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 30. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Detalhes do ativo do conjunto de dados de IA recém-criado. Tipo de dados: Objeto "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
acceptable_usage	Uso aceitável para o registro de ativo do conjunto de dados de IA. O uso aceitável se refere a como um conjunto de dados ou modelo pode ser usado, normalmente para fins de treinamento ou avaliação. Tipo de dados: Objeto "acceptable_usage": { "label": "String" "value": "String" }
label.acceptable_usage.label	Rótulo de exibição do valor de uso aceitável. Tipo de dados: Cadeia de caracteres
valor.acceptable_usage.value	Valor numérico do uso aceitável. Valores válidos: 1: Treinamento 2: Avaliação Tipo de dados: Cadeia de caracteres
result.base_datasets	Lista separada por vírgulas de conjuntos de dados base necessários para criar o conjunto de dados fornecido. Aceita o nome ou o sys_id de um conjunto de dados de base na tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Matriz "base_datasets": ["String", "String"]
resultado.criado	Data e hora em que o registro de ativo do conjunto de dados de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.data_type	O tipo de dados presentes no registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "data_type": { "label": "String", "value": "String" }
resultado.data_type.label	O rótulo de exibição do valor do tipo de dados. Tipo de dados: Cadeia de caracteres
valor.data_type.value	Valor do tipo de dados do ativo do conjunto de dados. Tipo de dados: Cadeia de caracteres
dataset_card.dataset_card	O cartão do conjunto de dados. Um dataset_card é um documento de metadados que descreve o conteúdo, a estrutura e o contexto de um conjunto de dados de IA. Ele fornece detalhes como fontes de dados, recursos, uso pretendido e quaisquer limitações conhecidas para garantir a compreensão e o uso adequados. Tipo de dados: Cadeia de caracteres
result.description	Descrição do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
display_name.display_name	Nome de exibição do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Detalhes sobre o usuário que gerencia o registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.name	Nome do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	SYS_id do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.name	Nome do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
result.provider	Provedor do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
result.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
origem.resultado	Detalhes sobre a origem do ativo do conjunto de dados de IA. Valores válidos: Link para a origem do ativo do conjunto de dados. Detalhes (em texto simples) da origem do ativo do conjunto de dados. Por exemplo, o nome de um produto ou site. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
estado.resultado	Estado do registro de ativo do conjunto de dados de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	SYS_id do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.atualizado	Data e hora em que o registro de ativo do conjunto de dados de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.versão	Número da versão do registro do modelo de produto do conjunto de dados de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres
avisos.resultado	Lista separada por vírgulas de mensagens de aviso presentes ao criar o conjunto de dados. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir mostra como criar um novo registro de ativo do conjunto de dados de 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" 
}'

Corpo da resposta. Os resultados do registro de ativo do conjunto de dados recém-criado.

{ 
  "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 de ativos de IA - POST /sn_ent/asset/ai_prompt

Cria uma nova entrada de ativo de prompt de IA nas tabelas Ativo digital de prompt de IA [alm_ai_prompt_digital_asset] e Modelo de produto de prompt de IA [cmdb_ai_promt_product_model] de acordo com os detalhes fornecidos no corpo da solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent//asset/ai_prompt

URL padrão: /api/sn_ent/asset/ai_prompt

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
objeto	Necessário. Conteúdo do ativo de prompt de IA a ser atualizado. Tipo de dados: Objeto { "ai_model": "String", "description": "String", "documentation": "String", "managed_by": "String" "name": "String", "prompt_info": "String", "provider": "String", "state": Number, "version": "String" }
ai_model	Valor do campo Modelo de IA de um registro existente na tabela Ativo digital do modelo de IA [alm_ai_model_digital_asset]. Valores válidos: Nome do registro Ativo digital do modelo de IA [alm_ai_model_digital_asset] SYS_id do registro Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
descrição	Descrição para fornecer o modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
documentação	Documentação do modelo de produto do prompt de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
managed_by	Valor do campo Gerenciado por de um registro existente na tabela Usuário [sys_user]. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
nome	Necessário. Nome do registro associado na tabela Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model]. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
prompt_info	Solicitar informações para ativo de prompt de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
provedor	Necessário. Valor do campo Provedor de um registro existente na tabela Empresa [core_company]. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
estado	Estado a ser aplicado ao ativo do modelo de IA. Por exemplo, Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
versão	Número da versão para atribuir o modelo de produto do prompt de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 36. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Resultados do novo prompt de ativo de IA. Tipo de dados: Objeto "result": { "asset": Object, "warnings": [Array] }
ativo.resultado	Detalhes sobre a entrada recém-criada. Tipo de dados: Objeto "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
asset.ai_model.result.asset.ai_model	Lista de modelos de IA no registro da tabela Ativo do sistema de IA [cmdb_ai_ system_asset_model]. Tipo de dados: Matriz "ai_model": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.name	Nome do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.ai_models.sys_id	SYS_id do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.ai_prompts.result.asset.ai	Lista de prompts de IA do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Matriz "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_prompts.name	Nome do prompt de IA. Tipo de dados: Cadeia de caracteres
asset.ai_prompts.sys_id	SYS_id do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
asset.asset.evaluation_datasets	Lista de sys_ids ou nomes de exibição dos conjuntos de dados de IA usados para avaliar o modelo de ativo do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.asset.evaluation_datasets.sys_id	SYS_id do registro de ativo digital do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
asset.evaluation_metrics_report	Resultados da avaliação do ativo do sistema de IA. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Detalhes sobre o usuário que gerencia o ativo. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.name	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.asset.name	Nome do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.asset.provider	Valor do campo Provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	Sys_id do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.aviso	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir mostra como usar o método POST para criar um novo prompt de IA de acordo com os detalhes fornecidos no corpo da solicitação.

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

Corpo da resposta.

{ 
  "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 de ativos de IA - POST /sn_ent/asset/ai_model

Cria uma nova entrada de ativo do modelo de IA nas tabelas Ativo digital do modelo de IA [alm_ai_model_digital_asset] e Modelo de produto do modelo de IA [cmdb_ai_model_product_model] de acordo com os detalhes fornecidos no corpo da solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent//asset/ai_model

URL padrão: /api/sn_ent/asset/ai_model

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
(objeto)	Necessário. Detalhes a serem aplicados ao novo registro do modelo de ativo. Tipo de dados: Objeto "object": { "base_model": {Object}, "context_window:" "String", "deployment_guideline": "String", "description": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String", "model_size_in_mb": "String", "model_weights_info": "String", "name": "String", "parameters_info": "String", "provider": "String", "required_infrastructure": "String", "source": "String", "state": Number, "supported_languages: [Array], "training_datasets": [Array], "training_procedure": "String", "version": "String" }
(objeto).base_model	Modelo de IA do qual esta versão do modelo foi derivada. Nota: Aplicável somente a modelos desenvolvidos na organização. Tipo de dados: Objeto { "name": "String", "sys_id": "String" }
.base_model.name	Nome do ativo do modelo de IA para modelar este modelo de IA após. Tipo de dados: Cadeia de caracteres
(objeto).base_model.sys_id	SYS_id do ativo do modelo de IA para modelar este modelo de IA após. Tabela: Ativo digital do modelo de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).context_window	Tamanho das sequências de entrada (em outras palavras, o número de tokens) que o modelo pode manipular. Tipo de dados: Inteiro Padrão: Valor vazio
(objeto).deployment_guideline	Instruções aplicáveis a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
descrição.objeto	Descrição para fornecer o modelo de produto do modelo de IA. Tabela atualizada: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).documentação	Documentação do modelo de produto do modelo de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).evaluation_datasets	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA dos conjuntos de dados de IA usados para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Matriz "evaluation_datasets": ["String", "String"] Valores válidos: Nome do registro de ativo digital do conjunto de dados de IA. SYS_id do registro de ativo digital do conjunto de dados de IA. Padrão: Cadeia de caracteres vazia
(objeto).evaluation_metrics_report	Referência aos resultados da avaliação localizados no campo de texto do registro de ativo digital do modelo de IA. Por exemplo: Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).managed_by	Valor do campo "Gerenciado por" de um registro existente na tabela Usuário [sys_user]. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).model_size_in_mb	Tamanho do modelo em MB. Aplicável principalmente a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Número Padrão: Nulo ou vazio
(objeto).model_weights_info	Informações adicionais do modelo, se disponíveis. Aplicável principalmente para modelos desenvolvidos em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Nulo ou vazio
(objeto).nome	Necessário. Nome do modelo de produto do modelo de IA. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres Padrão: Nulo ou vazio
(objeto).parameters_info	Número de parâmetros fornecidos a para o modelo. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).provedor	Necessário. Valor do campo "Provedor" do registro existente na tabela Empresa [core_company]. Atribui este provedor ao novo modelo de IA. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
(objeto).required_infrastructure	Documentação das necessidades de infraestrutura para a implantação do modelo. Por exemplo, detalhes sobre a pilha de infraestrutura e as necessidades de processamento. Aplicável principalmente a modelos implantados em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
(objeto).origem	Detalhes sobre a origem de quem ou o que criou o modelo. Valores válidos: Link para a origem do modelo. Por exemplo, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Ou um link para o Github. Detalhes da origem em texto simples. Por exemplo, Microsoft Azure Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
(objeto).estado	Estado a ser aplicado ao ativo do modelo de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
(objeto).supported_languages	Lista separada por vírgulas de idiomas compatíveis com o modelo de IA. Tipo de dados: Matriz "supported_languages": [ "String", "String" ] Valores válidos: SYS_id do registro de idioma [sys_language] Nome do registro de idioma [sys_language]. Por exemplo, "Francês", "Inglês" . Padrão: Cadeia de caracteres vazia
(objeto).training_datasets	Conjuntos de dados usados para treinar o modelo de IA. Lista separada por vírgulas de sys_ids ou nomes de exibição da tabela Ativo do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Aplicável principalmente para modelos desenvolvidos em uma organização. Tipo de dados: Matriz "training_datasets": [ "String", "String" ] Padrão: Cadeia de caracteres vazia
(objeto).training_procedure	Tipo de treinamento a ser aplicado ao modelo de IA. Valores válidos: 1: Árvores de decisão 2: Redes neurais profundas 3: Regressão linear 4: Regressão logística 5: Floresta aleatória 6: Aprendizado supervisionado 7: Aprendizado não supervisionado 8: Aprendizado por reforço 9: Transferir aprendizado 10: Aprendizado semi-supervisionado 11: Finetuning da instrução 12: Finetuning supervisionado Tipo de dados: Cadeia de caracteres representada com um número (por exemplo, "3" ) Padrão: 1: Árvores de decisão
(objeto).versão	Versão do modelo de produto do modelo de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia

Parâmetros do corpo da resposta (JSON ou XML)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 40. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 42. Códigos de status

Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Resultados da criação do ativo do modelo de IA. Tipo de dados: Objeto "result": { "asset": Object, "warnings": [Array], }
ativo.resultado	Detalhes sobre o ativo do modelo de IA criado. Tipo de dados: Objeto "asset": { "base_model": Object, "context_window": String, "created": "String", "deployment_guideline": String, "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "model_size_in_mb": String, "name": "String", "parameters_info": "String", "provider": Object, "required_infrastructure": String, "state": "String", "source": String, "supported_languages": Array, "sys_id": "String", "training_datasets": Array, "training_procedure": String, "updated": "String", "version": "String" }
asset.base_model.result.asset.base	Informações sobre o ativo do modelo de IA do qual esta versão é derivada. Tipo de dados: Objeto "base_model": { "name": "String", "sys_id": "String" }
result.asset.base_model.name	Nome de exibição do ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
asset.asset.base_model.sys_id	SYS_id do ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.context_window	Tamanho das sequências de entrada que o modelo pode manipular. Em outras palavras, o número de tokens. Tipo de dados: Cadeia de caracteres representada com um número. Por exemplo, "6000" .
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.deployment_guideline	Instruções aplicáveis a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] (campo display_name) Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.asset.evaluation_datasets	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo digital do modelo de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.evaluation_datasets.sys_id	SYS_id do registro de ativo digital do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
asset.evaluation_metrics_report	Referência aos resultados da avaliação. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Usuário que gerencia o registro de ativo do modelo de IA. Tipo de dados: Objeto " managed_by": { "name": "String", "sys_id": "String" }
result.asset.managed_by.name	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.asset.model_size_in_mb	Tamanho do modelo em MB. Geralmente aplicável a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Número
result.asset.name	Nome do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.asset.provider	Provedor do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Objeto "provider": { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do registro da tabela Empresa [core_company] que corresponde ao provedor do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.source.result.asset	Detalhes sobre a origem do ativo. Valores válidos: Link para a origem do modelo. Por exemplo, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Ou um link para o Github. Detalhes da origem em texto simples. Por exemplo, Microsoft Azure Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do registro de ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
result.asset.supported_languages.name	Nome do idioma compatível. Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
asset.supported_languages.sys_id	Sys_id do idioma compatível. Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	SYS_id do registro de ativo do modelo de IA Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.training_datasets	Referência a mais de 1 conjuntos de dados associados usados para treinar o modelo. Tipo de dados: Matriz "training_datasets": [ { "name": "String", "sys_id": "String" } ]
asset.result.training_procedure	Tipo de treinamento de IA aplicado ao modelo. Valores possíveis: 1: Árvores de decisão 2: Redes neurais profundas 3: Regressão linear 4: Regressão logística 5: Floresta aleatória 6: Aprendizado supervisionado 7: Aprendizado não supervisionado 8: Aprendizado por reforço 9: Transferir aprendizado 10: Aprendizado semi-supervisionado 11: Finetuning da instrução 12: Finetuning supervisionado Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
asset.version.result.asset	Versão do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [tabela cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.required_infrastructure	Documentação das necessidades de infraestrutura para a implantação do modelo. Por exemplo, detalhes sobre a pilha de infraestrutura e as necessidades de processamento. Tipo de dados: Cadeia de caracteres
asset.parameters_info.result.asset.parameters_info	Propriedades dos dados de treinamento que aprendem durante o processo de aprendizado. Por exemplo: 7B ou 30B . Tipo de dados: Cadeia de caracteres
asset.supported_languages	Detalhes sobre os idiomas compatíveis com o ativo do modelo de IA. Tabela: Idioma [sys_language] Tipo de dados: Objeto "supported_languages": [ { "name": "String", "sys_id": "String" } ]
avisos.resultado	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o SYSID de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir cria um ativo de modelo de IA de acordo com os detalhes fornecidos no corpo da solicitação.

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

O corpo da resposta mostra detalhes sobre o ativo do modelo de IA recém-criado, incluindo o sys_id resultante.

{
  "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 de ativos de IA - POST /sn_ent/asset/ai_system

Cria uma nova entrada de ativo do sistema de IA nas tabelas Ativo digital do sistema de IA [alm_ai_system_digital_asset] e Modelo de produto do sistema de IA [cmdb_ai_system_product_model] de acordo com os detalhes fornecidos no corpo da solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent//asset/ai_system

URL padrão: /api/sn_ent/asset/ai_system

Parâmetros de solicitação compatíveis

Tabela 43. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 44. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 45. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
objeto	Necessário. Detalhes a serem atualizados no sistema de IA. Tipo de dados: Objeto { "name": "String", "description": "String", "provider": "String", "version": "String", "state": Number, "documentation": "String", "ai_models": "String", "ai_prompts": "Strings", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String" }
object.name	Necessário. Nome do modelo de produto do sistema de IA. Tipo de dados: Cadeia de caracteres
object.description	Descrição do modelo de produto do sistema de IA. Tipo de dados: Cadeia de caracteres
object.provider	Necessário. Valor do campo Provedor em um registro de tabela Empresa [core_company] existente. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
object.state	Estado a ser aplicado ao ativo do sistema de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.version	Versão do modelo de produto do sistema de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
documentação.objeto	Documentação do ativo do sistema de IA. Tipo de dados: Cadeia de caracteres Padrão:
object.ai_models	Lista separada por vírgulas de cadeias de caracteres, em que cada cadeia de caracteres representa um valor de campo de modelo de IA de um registro de ativo digital de modelo de IA existente. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Valores válidos: Nome do registro de ativo digital do modelo de IA. SYS_id do registro de ativo digital do modelo de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.evaluation_datasets	Lista separada por vírgulas de conjuntos de dados de IA usados para avaliar o registro de ativo do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do sistema de IA [Ativo digital do sistema de IA alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [{String", "String"}] Valores válidos: Nome do registro de ativo digital do conjunto de dados de IA. SYS_id do registro de ativo digital do conjunto de dados de IA. Padrão: Cadeia de caracteres vazia
object.evaluation_metrics_report	Referência aos resultados da avaliação localizados no campo de texto do registro de ativo do sistema de IA. Por exemplo: Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.managed_by	Valor do campo "Gerenciado por" de um registro de tabela de Usuário [sys_user] existente. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 46. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 48. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Resultados do novo ativo do sistema de IA. Tipo de dados: Objeto "result": { "asset": Object, "warnings": [Array] }
ativo.resultado	Detalhes sobre a entrada recém-criada. Tipo de dados: Objeto "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": [Array], "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
asset.ai_models.result.asset.ai	Lista de modelos de IA no registro Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Matriz "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.name	Nome do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.ai_models.sys_id	SYS_id do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.ai_prompts.result.asset.ai	Lista de prompts de IA do registro Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Matriz "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_prompts.name	Nome do prompt de IA. Tipo de dados: Cadeia de caracteres
asset.ai_prompts.sys_id	SYS_id do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
asset.asset.evaluation_datasets	Lista de conjuntos de dados de IA usados para avaliar o registro de ativo do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.asset.evaluation_datasets.sys_id	SYS_id do registro da tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.evaluation_metrics_report	Resultados da avaliação do ativo do sistema de IA. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo do sistema de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.name	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.asset.name	Nome do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.asset.provider	Valor do campo Provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	Sys_id do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
asset.version.result.asset	Número da versão do registro do modelo de produto do sistema de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres
avisos.result.asset.warnings	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir insere uma nova entrada nas tabelas Ativo digital do sistema de IA e Modelo de produto do sistema de IA usando os detalhes incluídos no corpo da solicitação.

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

Corpo da resposta.

{ 
  "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 de ativos de IA: COLOQUE /sn_ent/asset/ai_dataset/(sys_id)

Atualiza os dados de um registro de ativo de conjunto de dados de IA específico de acordo com as informações fornecidas no corpo da solicitação.

Nota:

Forneça somente os pares parâmetro-valor para os dados específicos que você deseja atualizar. Este endpoint substitui os dados de todos os parâmetros enviados na solicitação.

Use o. API de ativos de IA - OBTER /sn_ent/asset/ai_dataset/(sys_id)Método para recuperar um registro de conjunto de dados de IA existente com um determinado ID. Em seguida, você pode usar este método PUT para atualizar valores no conjunto de dados usando as mesmas informações de ID.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_dataset/sys_id

URL padrão: /api/sn_ent/asset/ai_dataset/

Parâmetros de solicitação compatíveis

Tabela 49. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 50. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
(objeto)	{ "acceptable_usage": "String", "base_datasets": [Array], "dataset_card": "String" "data_type": "String", "description": "String", "documentation": "String", "managed_by": "String", "name": "String", "provider": "String", "state": "String" "source": "String", "version": "String" }
(objeto).acceptable_usage	Determina como um conjunto de dados ou modelo pode ser usado, normalmente para fins de treinamento ou avaliação. Valores válidos: 1: Treinamento 2: Avaliação Tipo de dados: Cadeia de caracteres
(objeto).base_datasets	Lista separada por vírgulas de conjuntos de dados base necessários para criar este conjunto de dados. Aceita nomes ou sys_ids de conjuntos de dados presentes na tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Matriz “base_datasets”: [ “String”, “String”]
(objeto).data_type	Tipo de dados presentes no conjunto de dados. Por exemplo, Texto, Vídeo, Imagem ou 1,2 . Tipo de dados: Cadeia de caracteres
(objeto).dataset_card	O cartão do conjunto de dados. Um dataset_card é um documento de metadados que descreve o conteúdo, a estrutura e o contexto de um conjunto de dados de IA. Ele fornece detalhes como fontes de dados, recursos, uso pretendido e quaisquer limitações conhecidas para garantir a compreensão e o uso adequados. Tipo de dados: Cadeia de caracteres
descrição.objeto	Descrição do registro associado na tabela Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
(objeto).documentação	Documentação do modelo de produto do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
(objeto).managed_by	Valor do campo Gerenciado por de um registro de tabela de Usuário [sys_user] existente. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres
(objeto).nome	Necessário. Nome do registro associado na tabela Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
(objeto).provedor	Necessário. Valor do campo Provedor de um registro existente na tabela Empresa [core_company]. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
(objeto).origem	Detalhes sobre a origem do conjunto de dados. Valores válidos: Link para a origem do conjunto de dados. Detalhes da origem em texto simples. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
(objeto).estado	Estado do ativo do conjunto de dados de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
(objeto).versão	Número da versão do registro do modelo de produto do conjunto de dados de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 52. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 54. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Detalhes do ativo do conjunto de dados de IA recém-criado. Tipo de dados: Objeto "result": { "acceptable_usage": {Object}, "base_datasets": [Array], "created": "String", "dataset_card": "String", "data_type": {Object}, "description": "String", "documentation": "String", "display_name": "String", "managed_by": {Object}, "name": "String", "provider": {Object}, "state": "Development", "source": "String", "sys_id": "String", "updated": "String", "version": "String", }
acceptable_usage	Uso aceitável para o registro de ativo do conjunto de dados de IA. O uso aceitável se refere a como um conjunto de dados ou modelo pode ser usado, normalmente para fins de treinamento ou avaliação. Tipo de dados: Objeto "acceptable_usage": { "label": "String" "value": "String" }
label.acceptable_usage.label	Rótulo de exibição do valor de uso aceitável. Tipo de dados: Cadeia de caracteres
valor.acceptable_usage.value	Valor numérico do uso aceitável. Valores válidos: 1: Treinamento 2: Avaliação Tipo de dados: Cadeia de caracteres
result.base_datasets	Lista separada por vírgulas de conjuntos de dados base necessários para criar o conjunto de dados fornecido. Aceita o nome ou o sys_id de um conjunto de dados de base na tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Matriz "base_datasets": ["String", "String"]
resultado.criado	Data e hora em que o registro de ativo do conjunto de dados de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.data_type	O tipo de dados presentes no registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "data_type": { "label": "String", "value": "String" }
resultado.data_type.label	O rótulo de exibição do valor do tipo de dados. Tipo de dados: Cadeia de caracteres
valor.data_type.value	Valor do tipo de dados do ativo do conjunto de dados. Tipo de dados: Cadeia de caracteres
dataset_card.dataset_card	O cartão do conjunto de dados. Um dataset_card é um documento de metadados que descreve o conteúdo, a estrutura e o contexto de um conjunto de dados de IA. Ele fornece detalhes como fontes de dados, recursos, uso pretendido e quaisquer limitações conhecidas para garantir a compreensão e o uso adequados. Tipo de dados: Cadeia de caracteres
result.description	Descrição do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
display_name.display_name	Nome de exibição do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
documentação.resultado	Documentação do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
resultado.gerenciado_por	Detalhes sobre o usuário que gerencia o registro de ativo do conjunto de dados de IA. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.managed_by.name	Nome do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.managed_by.sys_id	SYS_id do usuário que gerencia o registro de ativo do conjunto de dados de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.name	Nome do registro do modelo de produto do conjunto de dados de IA associado. Tabela: Modelo de produto do conjunto de dados de IA [cmdb_ai_dataset_product_model] Tipo de dados: Cadeia de caracteres
result.provider	Provedor do registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
result.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do conjunto de dados de IA associado [cmdb_ai_dataset_product_model]. Tipo de dados: Cadeia de caracteres
origem.resultado	Detalhes sobre a origem do ativo do conjunto de dados de IA. Valores válidos: Link para a origem do ativo do conjunto de dados. Detalhes (em texto simples) da origem do ativo do conjunto de dados. Por exemplo, o nome de um produto ou site. Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
estado.resultado	Estado do registro de ativo do conjunto de dados de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	SYS_id do registro de ativo do conjunto de dados de IA. Tabela: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.atualizado	Data e hora em que o registro de ativo do conjunto de dados de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
resultado.versão	Número da versão do registro do modelo de produto do conjunto de dados de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres
avisos.resultado	Lista separada por vírgulas de mensagens de aviso presentes ao criar o conjunto de dados. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir mostra como atualizar detalhes em um registro de conjunto de dados de IA com um determinado ID. O corpo da solicitação contém os valores de parâmetro a serem atualizados.

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

Corpo da resposta.

{ 
  "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 de ativos de IA - COLOQUE /sn_ent/asset/ai_prompt/(sys_id)

Atualiza os dados de um registro de ativo de prompt de IA específico de acordo com as informações fornecidas no corpo da solicitação.

Consulte também:

• API de ativos de IA - OBTER /sn_ent/asset/ai_system/sys_id
• API de ativos de IA - POST /sn_ent/asset/ai_prompt

Nota:

Forneça somente os pares parâmetro-valor para os dados específicos que você deseja atualizar. Este endpoint substitui os dados de todos os parâmetros enviados na solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_prompt/sys_id

URL padrão: /api/sn_ent/asset/ai_prompt/

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do prompt de IA [alm_ai_prompt_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 56. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 57. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
objeto	Necessário. Conteúdo do ativo de prompt de IA a ser atualizado. Tipo de dados: Objeto { "ai_model": "String", "description": "String", "documentation": "String", "managed_by": "String" "name": "String", "prompt_info": "String", "provider": "String", "state": Number, "version": "String" }
ai_model	Valor do campo Modelo de IA de um registro existente na tabela Ativo digital do modelo de IA [alm_ai_model_digital_asset]. Valores válidos: Nome do registro Ativo digital do modelo de IA [alm_ai_model_digital_asset] SYS_id do registro Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
descrição	Descrição para fornecer o modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
documentação	Documentação do modelo de produto do prompt de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
managed_by	Valor do campo Gerenciado por de um registro existente na tabela Usuário [sys_user]. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
nome	Necessário. Nome do registro associado na tabela Modelo de produto do prompt de IA [cmdb_ai_prompt_product_model]. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
prompt_info	Solicitar informações para ativo de prompt de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
provedor	Necessário. Valor do campo Provedor de um registro existente na tabela Empresa [core_company]. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
estado	Estado a ser aplicado ao ativo do modelo de IA. Por exemplo, Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
versão	Número da versão para atribuir o modelo de produto do prompt de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 58. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 59. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 60. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta

Nome	Descrição
resultado	result: { "asset": {Object}, "warnings": [Array] }
ativo.resultado	Detalhes sobre a entrada recém-criada. Tipo de dados: Objeto "asset": { "ai_model": Object, "created": "String", "description": "String", "display_name": "String", "documentation": "String", "managed_by": Object, "name": "String", "prompt_info": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
asset.ai_model.result.asset.ai_model	Lista de modelos de IA no registro da tabela Ativo do sistema de IA [cmdb_ai_ system_asset_model]. Tipo de dados: Matriz "ai_model": [ { "name": "String", "sys_id": "String" } ]
result.asset.ai_models.name	Nome do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.ai_models.sys_id	SYS_id do registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Detalhes sobre o usuário que gerencia o ativo. Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.name	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.asset.name	Nome do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.asset.prompt_info	Informações do prompt do registro de ativo do prompt de IA. Tipo de dados: Cadeia de caracteres
result.asset.provider	Valor do campo Provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	Sys_id do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
asset.version.result.asset	Número da versão do registro do modelo de produto do sistema de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres
resultado.aviso	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir atualiza os dados do ativo de prompt de IA com o sys_id fornecido de acordo com os valores de parâmetro fornecidos no corpo da solicitação.

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

Corpo da resposta:

{
  "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 de ativos de IA - COLOQUE /sn_ent/asset/ai_system/(sys_id)

Atualiza os dados de um registro específico do sistema de IA de acordo com as informações fornecidas no corpo da solicitação.

Nota:

Forneça somente os pares parâmetro-valor para os dados específicos que você deseja atualizar. Este endpoint substitui os dados de todos os parâmetros enviados na solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_system/sys_id

URL padrão: /api/sn_ent/asset/ai_system/

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 62. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 63. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
objeto	Necessário. Detalhes a serem atualizados no sistema de IA. Tipo de dados: Objeto { "name": "String", "description": "String", "provider": "String", "version": "String", "state": Number, "documentation": "String", "ai_models": "String", "ai_prompts": "Strings", "evaluation_datasets": [Array], "evaluation_metrics_report": "String", "managed_by": "String" }
object.name	Necessário. Nome do modelo de produto do sistema de IA. Tipo de dados: Cadeia de caracteres
object.description	Descrição do modelo de produto do sistema de IA. Tipo de dados: Cadeia de caracteres
object.provider	Necessário. Valor do campo Provedor em um registro de tabela Empresa [core_company] existente. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
object.state	Estado a ser aplicado ao ativo do sistema de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.version	Versão do modelo de produto do sistema de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
documentação.objeto	Documentação do ativo do sistema de IA. Tipo de dados: Cadeia de caracteres Padrão:
object.ai_models	Lista separada por vírgulas de cadeias de caracteres, em que cada cadeia de caracteres representa um valor de campo de modelo de IA de um registro de ativo digital de modelo de IA existente. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Valores válidos: Nome do registro de ativo digital do modelo de IA. SYS_id do registro de ativo digital do modelo de IA. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.evaluation_datasets	Lista separada por vírgulas de conjuntos de dados de IA usados para avaliar o registro de ativo do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do sistema de IA [Ativo digital do sistema de IA alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [{String", "String"}] Valores válidos: Nome do registro de ativo digital do conjunto de dados de IA. SYS_id do registro de ativo digital do conjunto de dados de IA. Padrão: Cadeia de caracteres vazia
object.evaluation_metrics_report	Referência aos resultados da avaliação localizados no campo de texto do registro de ativo do sistema de IA. Por exemplo: Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
object.managed_by	Valor do campo "Gerenciado por" de um registro de tabela de Usuário [sys_user] existente. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 64. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 65. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 66. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. Falha ao buscar o ativo com o sys_id fornecido.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Resultados do ativo atualizado do sistema de IA. Tipo de dados: Objeto "result": { "asset": Object, "warnings": [Array] }
ativo.resultado	Detalhes sobre o ativo recém-criado. Tipo de dados: Objeto "asset": { "ai_model": [Array], "ai_prompts": [Array] "created": "String", "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "name": "String", "provider": Object, "state": "String", "sys_id": "String", "updated": "String", "version": "String", "warnings": [Array] }
resultado.ai_models	Lista de modelos de IA no registro da tabela Ativo digital do sistema de IA [alm_ai_system_digital_asset]. Tipo de dados: Matriz "ai_models": [ { "name": "String", "sys_id": "String" } ]
result.ai_models.name	Nome do registro de ativo digital do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
resultado.ai_models.sys_id	SYS_id do registro de ativo digital do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ai_prompts	Lista de prompts de IA no registro de ativo do sistema de IA. Tipo de dados: Matriz "ai_prompts": [ { "name": "String", "sys_id": "String" } ]
result.ai_prompts.name	Nome do prompt de IA. Tipo de dados: Cadeia de caracteres
ai_prompts.sys_id	SYS_id do registro de ativo digital do prompt de IA. Tabela: Ativo digital do prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Cadeia de caracteres
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
asset.asset.evaluation_datasets	Lista de conjuntos de dados de IA usados para avaliar o registro de ativo do sistema de IA. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.asset.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.asset.evaluation_datasets.sys_id	SYS_id do registro da tabela Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Tipo de dados: Cadeia de caracteres
asset.evaluation_metrics_report	Resultados da avaliação do ativo do sistema de IA. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo do sistema de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Objeto "managed_by": [ { "name": "String", "sys_id": "String" } ]
result.asset.managed_by.name	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
result.asset.name	Nome do registro do modelo de produto do sistema de IA associado. Tabela: Modelo de produto do sistema de IA [cmdb_ai_system_product_model] Tipo de dados: Cadeia de caracteres
result.asset.provider	Valor do campo Provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Objeto provider: { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do provedor no registro da tabela Modelo de produto do sistema de IA associado [cmdb_ai_ system_product_model]. Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	Sys_id do registro de ativo do sistema de IA. Tabela: Ativo digital do sistema de IA [alm_ai_system_digital_asset] Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
asset.version.result.asset	Número da versão do registro do modelo de produto do sistema de IA associado. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres
avisos.result.asset.warnings	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o sys_id de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir atualiza o sistema de IA com detalhes a serem atualizados no corpo da solicitação.

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

O corpo da resposta mostra os resultados da atualização que foi aplicada ao sys_id do sistema de IA fornecido.

{ 
  "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 de ativos de IA - COLOQUE /sn_ent/asset/ai_model/(sys_id)

Atualiza os dados de um registro de ativo de modelo de IA específico de acordo com as informações fornecidas no corpo da solicitação.

Nota:

Forneça somente os pares parâmetro-valor para dados específicos que você deseja atualizar. Este endpoint substitui os dados de todos os parâmetros enviados na solicitação.

Formato de URL

URL com controle de versão: /api/sn_ent/api/asset/ai_model/sys_id

URL padrão: /api/sn_ent/asset/ai_model/

Parâmetros de solicitação compatíveis

Tabela 67. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
sys_id	SYS_id do ativo na tabela Ativo do prompt de IA [alm_ai_prompt_digital_asset]. Tipo de dados: Cadeia de caracteres

Tabela 68. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 69. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
objeto	Necessário. Detalhes a serem atualizados no modelo de IA fornecido. Tipo de dados: Objeto { "base_model": "String", "context_window": "String", "deployment_guideline": "String", "description": "String", "documentation": "String", "evaluation_datasets": "String", "evaluation_metrics_report": "String", "managed_by": "String", "model_size_in_mb": "String", "model_weights_info": "String", "name": "String", "parameters_info": "String", "provider": "String", "required_infrastructure": "String", "state": Number, "supported_languages": "String", "training_datasets": "String", "training_procedure": "String", "version": "String" }
modelo_base	Modelo de IA do qual esta versão do modelo foi derivada. Nota: Aplicável somente a modelos desenvolvidos na organização. Tipo de dados: Objeto { "name": "String", "sys_id": "String" } Padrão: Objeto vazio
base_model.name	Nome do ativo do modelo de IA para modelar este modelo de IA após. Tipo de dados: Cadeia de caracteres
base_model.sys_id	SYS_id do ativo do modelo de IA para modelar este modelo de IA após. Tabela: Ativo digital do modelo de IA alm_ai_model_digital_asset Tipo de dados: Cadeia de caracteres
context_window	Tamanho das sequências de entrada (em outras palavras, o número de tokens) que o modelo pode manipular. Tipo de dados: Inteiro Padrão: 0
deployment_guideline	Instruções aplicáveis a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Vazio
descrição	Descrição para fornecer o modelo de produto do modelo de IA. Atualizado na tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres Padrão: Vazio
documentação	Documentação do registro do modelo de produto do prompt de IA. Tabela: Modelo de produto do prompt de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres Padrão: Vazio
evaluation_datasets	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo digital de prompt de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo digital do prompt de IA [alm_ai_prompt_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ "String", "String" ] Valores válidos: Nome do registro de ativo digital do conjunto de dados de IA. SYS_id do registro de ativo digital do conjunto de dados de IA. Padrão: Cadeia de caracteres vazia
evaluation_metrics_report	Referência aos resultados da avaliação localizados no campo de texto do registro de ativo do conjunto de dados de IA. Por exemplo: Testing results: link to the result document Details: Accuracy: 85% Hallucination: 10% Eval Run 1: link Eval Run 2: link Tabela: Ativo do conjunto de dados de IA [alm_ai_dataset_digital_asset] Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
managed_by	Valor do campo "Gerenciado por" de um registro existente na tabela Usuário [sys_user]. Valores válidos: Nome do registro do usuário [sys_user] Sys_id do registro do usuário [sys_user] Tipo de dados: Cadeia de caracteres Padrão: Vazio
model_size_in_mb	Tamanho do modelo em MB. Aplicável principalmente a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Número Padrão: Vazio
model_weights_info	Informações adicionais do modelo, se disponíveis. Aplicável principalmente para modelos desenvolvidos em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Vazio
nome	Necessário. Nome do modelo de produto do modelo de IA. Atualizado na tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
parameters_info	Número de parâmetros a serem fornecidos ao modelo. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres vazia
provedor	Necessário. Valor do campo "Provedor" de um registro de tabela Empresa [core_company] existente. Atribui este provedor ao novo modelo de IA. Valores válidos: Nome do registro da empresa [core_company] Sys_id do registro da empresa [core_company] Tipo de dados: Cadeia de caracteres
required_infrastructure	Documentação das necessidades de infraestrutura para a implantação do modelo. Por exemplo, detalhes sobre a pilha de infraestrutura e as necessidades de processamento. Aplicável principalmente a modelos implantados em uma organização. Tipo de dados: Cadeia de caracteres Padrão: Vazio
origem	Detalhes sobre a origem de quem ou o que criou o modelo. Valores válidos: Link para a origem do modelo. Por exemplo, https://huggingface.co/mistralai/model1 Ou um link para o Github. Detalhes da origem em texto simples. Por exemplo, Microsoft Azure Tipo de dados: Cadeia de caracteres Padrão: Vazio ou nulo
estado	Estado a ser aplicado ao ativo do modelo de IA. Valores válidos: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
supported_languages	Lista separada por vírgulas de idiomas compatíveis com o modelo de IA. Tipo de dados: Matriz "supported_languages": [ "String", "String" ] Valores válidos: Sys_id do registro de Idioma [sys_language] Nome do registro de idioma [sys_language]. Por exemplo, "Francês", "Inglês" Padrão: Cadeia de caracteres vazia
training_datasets	Referência a mais de 1 conjuntos de dados associados usados para treinar o modelo. Lista separada por vírgulas de sys_ids ou nomes de exibição da tabela Ativo do conjunto de dados de IA [alm_ai_dataset_digital_asset]. Aplicável principalmente para modelos desenvolvidos em uma organização. Tipo de dados: Matriz "training_datasets": [ "String", "String" ] Padrão: Cadeia de caracteres vazia
training_procedure	Tipo de treinamento a ser aplicado ao modelo de IA. Valores válidos: 1: Árvores de decisão 2: Redes neurais profundas 3: Regressão linear 4: Regressão logística 5: Floresta aleatória 6: Aprendizado supervisionado 7: Aprendizado não supervisionado 8: Aprendizado por reforço 9: Transferir aprendizado 10: Aprendizado semi-supervisionado 11: Finetuning da instrução 12: Finetuning supervisionado Tipo de dados: Cadeia de caracteres representada com um número (por exemplo, "3" ) Padrão: 1: Árvores de decisão
versão	Versão do modelo de produto do modelo de IA. Por exemplo, V2 . Tipo de dados: Cadeia de caracteres Padrão: Vazio

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da REST API compatíveis .

Tabela 70. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 71. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

Tabela 72. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Resultados da criação do ativo do modelo de IA. Tipo de dados: Objeto "result": { "asset": Object, "warnings": [Array], }
ativo.resultado	Detalhes sobre o ativo do modelo de IA criado. Tipo de dados: Objeto "asset": { "base_model": Object, "context_window": String, "created": "String", "deployment_guideline": String, "description": "String", "display_name": "String", "documentation": "String", "evaluation_datasets": Array, "evaluation_metrics_report": String, "managed_by": Object, "model_size_in_mb": String, "name": "String", "parameters_info": "String", "provider": Object, "required_infrastructure": String, "state": "String", "source": String, "supported_languages": Array, "sys_id": "String", "training_datasets": Array, "training_procedure": String, "updated": "String", "version": "String" }
asset.base_model.result.asset.base	Informações sobre o ativo do modelo de IA do qual esta versão é derivada. Tipo de dados: Objeto "base_model": { "name": "String", "sys_id": "String" }
result.asset.base_model.name	Nome de exibição do ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
asset.asset.base_model.sys_id	SYS_id do ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.context_window	Tamanho das sequências de entrada que o modelo pode manipular. Em outras palavras, o número de tokens. Tipo de dados: Cadeia de caracteres representada com um número. Por exemplo, "6000" .
ativo.result.criado	Data e hora em que o ativo do modelo de IA foi criado. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
result.asset.deployment_guideline	Instruções aplicáveis a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Cadeia de caracteres
result.asset.description	Descrição do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.display_name.result.asset.display_name	Nome de exibição do registro de ativo do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] (campo display_name) Tipo de dados: Cadeia de caracteres
result.asset.documentation	Documentação do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.asset.evaluation_datasets	Lista separada por vírgulas de sys_ids ou nomes de exibição de conjuntos de dados de IA do ativo digital do modelo de IA usado para avaliar o modelo. Aplicável principalmente para modelos desenvolvidos em uma organização. Tabelas: Ativo digital do conjunto de dados de IA [alm_ai_dataset_digital_asset], Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Matriz "evaluation_datasets": [ { "name": "String", "sys_id": "String" } ]
result.evaluation_datasets.name	Nome do ativo digital do conjunto de dados de IA. Tipo de dados: Cadeia de caracteres
result.evaluation_datasets.sys_id	SYS_id do registro de ativo digital do modelo de IA. Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
asset.evaluation_metrics_report	Referência aos resultados da avaliação. Valores possíveis: Detalhes (em texto simples) que descrevem os resultados Links para resultados específicos Tipo de dados: Cadeia de caracteres
asset.result.managed_by	Usuário que gerencia o registro de ativo do modelo de IA. Tipo de dados: Objeto " managed_by": { "name": "String", "sys_id": "String" }
result.asset.managed_by.name	Nome do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
asset.managed_by.sys_id	Sys_id do usuário que gerencia o registro de ativo do modelo de IA. Tabela: Usuário [usuário] Tipo de dados: Cadeia de caracteres
resultado.asset.model_size_in_mb	Tamanho do modelo em MB. Geralmente aplicável a modelos desenvolvidos e implantados em uma organização. Tipo de dados: Número
result.asset.name	Nome do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.asset.provider	Provedor do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Objeto "provider": { "name": "String", "sys_id": "String" }
result.asset.provider.name	Nome do provedor. Tipo de dados: Cadeia de caracteres
result.asset.provider.sys_id	Sys_id do registro da tabela Empresa [core_company] que corresponde ao provedor do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
asset.source.result.asset	Detalhes sobre a origem do ativo. Valores válidos: Link para a origem do modelo. Por exemplo, https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 Ou um link para o Github. Detalhes da origem em texto simples. Por exemplo, Microsoft Azure Tipo de dados: Cadeia de caracteres
estado.ativo.resultado	Estado do registro de ativo do modelo de IA. Valores possíveis: 1: Em uso 31: Implantado 32: Descontinuado 33: Desenvolvimento 34: Desconhecido 35: N/D. Tipo de dados: Cadeia de caracteres
result.asset.supported_languages.name	Nome do idioma compatível. Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
asset.supported_languages.sys_id	Sys_id do idioma compatível. Tabela: Idioma [sys_language] Tipo de dados: Cadeia de caracteres
asset.sys_id.result.asset.sys_id	SYS_id do registro de ativo do modelo de IA Tabela: Ativo digital do modelo de IA [alm_ai_model_digital_asset] Tipo de dados: Cadeia de caracteres
result.asset.training_datasets	Referência a mais de 1 conjuntos de dados associados usados para treinar o modelo. Tipo de dados: Matriz "training_datasets": [ { "name": "String", "sys_id": "String" } ]
asset.result.training_procedure	Tipo de treinamento de IA aplicado ao modelo. Valores possíveis: 1: Árvores de decisão 2: Redes neurais profundas 3: Regressão linear 4: Regressão logística 5: Floresta aleatória 6: Aprendizado supervisionado 7: Aprendizado não supervisionado 8: Aprendizado por reforço 9: Transferir aprendizado 10: Aprendizado semi-supervisionado 11: Finetuning da instrução 12: Finetuning supervisionado Tipo de dados: Cadeia de caracteres
ativo.resultado.atualizado	Data e hora em que o ativo do modelo de IA foi atualizado pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
asset.version.result.asset	Versão do registro do modelo de produto do modelo de IA associado. Tabela: Modelo de produto do modelo de IA [tabela cmdb_ai_model_product_model] Tipo de dados: Cadeia de caracteres
result.required_infrastructure	Documentação das necessidades de infraestrutura para a implantação do modelo. Por exemplo, detalhes sobre a pilha de infraestrutura e as necessidades de processamento. Tipo de dados: Cadeia de caracteres
asset.parameters_info.result.asset.parameters_info	Propriedades dos dados de treinamento que aprendem durante o processo de aprendizado. Por exemplo: 7B ou 30B . Tipo de dados: Cadeia de caracteres
asset.supported_languages	Detalhes sobre os idiomas compatíveis com o ativo do modelo de IA. Tabela: Idioma [sys_language] Tipo de dados: Objeto "supported_languages": [ { "name": "String", "sys_id": "String" } ]
avisos.resultado	Lista separada por vírgulas de mensagens de aviso. Esses avisos podem ser verificações de validação, como quando o SYSID de um parâmetro opcional é inválido. Tipo de dados: Matriz "warnings": ["String"]

Solicitação de curl

O exemplo a seguir mostra como atualizar um determinado modelo de ativo de IA usando o método 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" 
}' 

Corpo da resposta.

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