Listando modelos de idioma customizados

A interface de customização fornece dois métodos para listar informações sobre os modelos de idioma customizados pertencentes às credenciais especificadas:

• O método GET /v1/customizations lista informações sobre todos os modelos de idioma customizados ou, se você especificar o parâmetro language, sobre todos os modelos de idioma customizados para o idioma especificado. Se você especificar um idioma, use o identificador de idioma do nome do modelo de base, por exemplo, en-US para um modelo em inglês dos EUA.
• O método GET /v1/customizations/{customization_id} lista informações sobre um modelo de idioma customizado especificado. Use esse método para pesquisar o serviço sobre o status de uma solicitação de treinamento ou uma solicitação para incluir novas palavras.

Os dois métodos retornam as informações a seguir sobre um modelo customizado:

• customization_id identifica o Identificador Exclusivo Global (GUID) do modelo customizado. O GUID é usado para identificar o modelo em métodos da interface.
• created é a data e hora na Hora Universal Coordenada (UTC) na qual o modelo customizado foi criado.
• updated é a data e a hora na Hora Universal Coordenada (UTC) em que o modelo customizado foi modificado pela última vez.
• language é o idioma do modelo customizado. O valor corresponde ao identificador de idioma do nome do modelo de base. Por exemplo, en-US para um modelo em inglês dos EUA.
• dialect é o dialeto do idioma para o modelo customizado, que não corresponde necessariamente ao idioma do modelo customizado para os modelos de geração anterior em espanhol. Para obter mais informações, consulte a descrição do campo dialect em Criar um modelo de idioma customizado.
• owner identifica as credenciais da instância de serviço que tem o modelo customizado.
• name é o nome do modelo customizado.
• description mostrará a descrição do modelo customizado, se uma foi fornecida em sua criação.
• base_model indica o nome do modelo de idioma para o qual o modelo customizado foi criado.
• versions fornece uma lista das versões disponíveis do modelo customizado. Cada elemento da matriz indica uma versão do modelo base com a qual o modelo customizado pode ser usado. Existirão várias versões somente se o modelo customizado for atualizado para uma nova versão do modelo de base. Caso contrário, somente uma única versão será mostrada. Para obter mais informações, consulte Listando informações de versão para um modelo customizado.

O método também retorna um campo status que indica o estado do modelo customizado:

• pending indica que o modelo foi criado. Ele aguarda que dados de treinamento válidos (corpora, palavras ou gramáticas) sejam incluídos ou que o serviço termine de analisar os dados que foram incluídos.
• ready indica que o modelo contém dados válidos e está pronto para ser treinado. Se o modelo contiver uma combinação de recursos válidos e inválidos, o treinamento do modelo falhará, a menos que você configure o parâmetro de consulta strict como false. Para obter mais informações, consulte Falhas de treinamento.
• training indica que o modelo está sendo treinado nos dados.
• available indica que o modelo está treinado e pronto para uso com uma solicitação de reconhecimento.
• upgrading indica que o modelo está passando por upgrade.
• failed indica que o treinamento do modelo falhou. Examine as palavras no recurso de palavras do modelo para determinar os erros que impediram o treinamento do modelo.

Além disso, a saída inclui um campo progress que indica o status do treinamento de um modelo customizado. Se você usou o método POST /v1/customizations/{customization_id}/train para treinar com sucesso o modelo, este campo terá um valor de 100. Se o modelo não for completamente treinado e available, o campo terá um valor de 0.

Ao monitorar o treinamento ou a atualização de um modelo personalizado, pesquise o valor do campo status, não o valor do campo progress. Se a operação falhar por qualquer motivo, o valor do campo status será alterado para refletir a falha; o valor do campo progress permanecerá 0.

curl -X GET -u "apikey:{apikey}" \
"{url}/v1/customizations?language=en-US"

curl -X GET \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations?language=en-US"

{
  "customizations": [
    {
      "customization_id": "74f4807e-b5ff-4866-824e-6bba1a84fe96",
      "created": "2016-06-01T14:21:26.894Z",
      "updated": "2020-01-18T18:42:25.324Z",
      "language": "en-US",
      "dialect": "en-US",
      "versions": [
        "en-US_BroadbandModel.v2018-07-31",
        "en-US_BroadbandModel.v2020-01-16"
      ],
      "owner": "297cfd08-330a-22ba-93ce-1a73f454dd98",
      "name": "Example model",
      "description": "Example custom language model",
      "base_model_name": "en-US_BroadbandModel",
      "status": "pending",
      "progress": 0
    },
    {
      "customization_id": "8391f918-3b76-e109-763c-b7732fae4829",
      "created": "2017-12-02T18:51:37.291Z",
      "updated": "2017-12-02T20:02:10.624Z",
      "language": "en-US",
      "dialect": "en-US",
      "versions": [
        "en-US_BroadbandModel.v2017-11-15"
      ],
      "owner": "297cfd08-330a-22ba-93ce-1a73f454dd98",
      "name": "Example model two",
      "description": "Example custom language model two",
      "base_model_name": "en-US_BroadbandModel",
      "status": "available",
      "progress": 100
    }
  ]
}

curl -X GET -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}"

curl -X GET \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}"

{
  "customization_id": "74f4807e-b5ff-4866-824e-6bba1a84fe96",
  "created": "2016-06-01T14:21:26.894Z",
  "updated": "2020-01-18T18:42:25.324Z",
  "language": "en-US",
  "dialect": "en-US",
  "versions": [
    "en-US_BroadbandModel.v2018-07-31",
    "en-US_BroadbandModel.v2020-01-16"
  ],
  "owner": "297cfd08-330a-22ba-93ce-1a73f454dd98",
  "name": "Example model",
  "description": "Example custom language model",
  "base_model_name": "en-US_BroadbandModel",
  "status": "pending",
  "progress": 0
}

Reconfigurando um modelo de idioma customizado

Use o método POST /v1/customizations/{customization_id}/reset para reconfigurar um modelo customizado. A reconfiguração de um modelo remove todos os corpora e as palavras do modelo, inicializando o modelo para seu estado na criação. O método não exclui o próprio modelo ou os metadados, como seu nome e idioma. No entanto, quando você reconfigura um modelo, seu recurso de palavras está vazio e deve ser recriado por meio da inclusão de corpora e palavras.

curl -X POST -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}/reset"

curl -X POST \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}/reset"

Excluindo um modelo de idioma customizado

Use o método DELETE /v1/customizations/{customization_id} para excluir um modelo de idioma customizado que você não precisa mais. Ele exclui todo o corpora que está associado ao modelo customizado e ao próprio modelo. Use esse método com cuidado: um modelo customizado e seus dados não podem ser recuperados depois da exclusão do modelo.

curl -X DELETE -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}"

curl -X DELETE \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}"