Consultar os resultados do aprovisionamento

Analise a tarefa, os conjuntos gerados, o trabalho ignorado e as falhas parciais.

Consulte uma tarefa de aprovisionamento com o ID devolvido no momento da criação:

http
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEY

Campos da tarefa #

CampoSignificado
id, organizationId, engineIdIdentificação da tarefa e da organização e do motor a que pertence.
statusEstado identificado como Running, Completed ou Failed. Failed inclui message.
kindsResultados do trabalho solicitado para glossary, ruleset e brandVoice. Os tipos não solicitados podem não estar presentes.
sourcesProgresso ou relatório de leitura das fontes, opcional.
websitePrimeiro URL de um site fornecido; ausente quando os dados de entrada contêm apenas texto.
createdAtData e hora de criação em formato ISO.
finishedAtData e hora de conclusão em formato ISO, disponíveis após a finalização.

Estados por tipo #

Verifique todos os tipos solicitados, mesmo quando a tarefa de nível superior está no estado Completed:

kinds.<kind>._tagCampos e significado
PendingEm processamento. O campo opcional step tem o valor reading, generating ou saving; startedAt indica quando essa etapa começou.
DonesetId identifica o conjunto associado; itemCount indica o número de itens gerados.
Skippedreason explica por que motivo o tipo foi mantido inalterado.
Failedmessage explica por que motivo não foi possível preencher o tipo.

Por exemplo, este excerto dos resultados contém um glossário gerado e um conjunto de regras cuja geração falhou:

json
{
  "glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
  "ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}

Cada tipo é guardado de forma independente. As orientações geradas com êxito continuam disponíveis se outro tipo falhar. Também pode ser associado um conjunto a um motor enquanto a geração está em curso, o que pode levar a que o preenchimento apenas de tipos vazios ou o preenchimento da voz da marca seja ignorado.

Analisar os registos gerados #

Abra o motor no Studio e aceda ao glossário, ao conjunto de regras ou à voz da marca associados. Para consultar os dados através da API, utilize:

  • GET /v2/glossaries/:id/terms para as entradas do glossário.
  • GET /v2/rulesets/:id/rules para as regras.
  • GET /v2/brand-voices/:id/variations para as variações de voz.

Utilize o setId correspondente e percorra as páginas de cada lista. Verifique a terminologia, a aplicabilidade por idioma, os nomes não traduzíveis e quaisquer pressupostos acrescentados pelo modelo. A contagem de itens indica quantos registos foram criados, não se estão corretos.

Se um tipo falhar, consulte nova tentativa e recuperação. Mantenha os conjuntos concluídos em vez de criar outro motor para repetir todo o trabalho.