Analyze Conversations Job Status - Analyze Conversations Job Status
Obter o status e os resultados da análise
Obtenha o status de um trabalho de análise. Um trabalho pode consistir em uma ou mais tarefas. Depois que todas as tarefas forem bem-sucedidas, o trabalho fará a transição para o estado bem-sucedido e os resultados estarão disponíveis para cada tarefa.
GET {Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-11-01
GET {Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-11-01&showStats={showStats}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string (uuid) |
ID do trabalho |
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
show
|
query |
boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
SuccessfulConversationPIIExclusionTaskStatusRequest
Solicitação de exemplo
GET {Endpoint}/language/analyze-conversations/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01
Resposta de exemplo
{
"createdDateTime": "2020-10-01T15:00:45Z",
"displayName": "Redacting PII from transcribed audio",
"expirationDateTime": "2020-10-03T15:01:03Z",
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
"lastUpdatedDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "conversationalPIIResults",
"taskName": "Conversation PII",
"lastUpdateDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"results": {
"conversations": [
{
"id": "1",
"conversationItems": [
{
"id": "1",
"redactedContent": {
"text": "Good morning *************.",
"itn": "good morning *************",
"maskedItn": "good morning *************",
"lexical": "good morning *************",
"audioTimings": [
{
"offset": 590000,
"duration": 920000
}
]
},
"entities": []
}
],
"warnings": [],
"statistics": {
"transactionsCount": 1
}
}
],
"errors": [],
"modelVersion": "2022-05-15-preview"
}
}
]
}
}
SuccessfulConversationPIIRedactionCharTaskStatusRequest
Solicitação de exemplo
GET {Endpoint}/language/analyze-conversations/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01
Resposta de exemplo
{
"createdDateTime": "2020-10-01T15:00:45Z",
"displayName": "Redacting PII from transcribed audio",
"expirationDateTime": "2020-10-03T15:01:03Z",
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
"lastUpdatedDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "conversationalPIIResults",
"taskName": "Conversation PII",
"lastUpdateDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"results": {
"conversations": [
{
"id": "1",
"conversationItems": [
{
"id": "1",
"redactedContent": {
"text": "Good morning -------------.",
"itn": "good morning -------------",
"maskedItn": "good morning -------------",
"lexical": "good morning -------------",
"audioTimings": [
{
"offset": 590000,
"duration": 920000
}
]
},
"entities": [
{
"category": "Person",
"confidenceScore": 0.91,
"length": 8,
"offset": 13,
"text": "john doe"
}
]
}
],
"warnings": [],
"statistics": {
"transactionsCount": 1
}
}
],
"errors": [],
"modelVersion": "2022-05-15-preview"
}
}
]
}
}
SuccessfulConversationPIITaskStatusRequest
Solicitação de exemplo
GET {Endpoint}/language/analyze-conversations/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01
Resposta de exemplo
{
"createdDateTime": "2020-10-01T15:00:45Z",
"displayName": "Redacting PII from transcribed audio",
"expirationDateTime": "2020-10-03T15:01:03Z",
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
"lastUpdatedDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "conversationalPIIResults",
"taskName": "Conversation PII",
"lastUpdateDateTime": "2022-01-25T15:01:03Z",
"status": "succeeded",
"results": {
"conversations": [
{
"id": "1",
"conversationItems": [
{
"id": "1",
"redactedContent": {
"text": "Good morning *************.",
"itn": "good morning *************",
"maskedItn": "good morning *************",
"lexical": "good morning *************",
"audioTimings": [
{
"offset": 590000,
"duration": 920000
}
]
},
"entities": [
{
"category": "Person",
"confidenceScore": 0.91,
"length": 8,
"offset": 13,
"text": "john doe"
}
]
}
],
"warnings": [],
"statistics": {
"transactionsCount": 1
}
}
],
"errors": [],
"modelVersion": "2022-05-15-preview"
}
}
]
}
}
SuccessfulConversationSummarizationTaskResult
Solicitação de exemplo
GET {Endpoint}/language/analyze-conversations/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?api-version=2024-11-01
Resposta de exemplo
{
"displayName": "Conversation Summarization Example",
"createdDateTime": "2022-04-01T15:00:45Z",
"expirationDateTime": "2022-04-02T15:00:45Z",
"jobId": "3e9e8518-492f-47f9-abd1-9a7468231086",
"lastUpdatedDateTime": "2022-04-01T15:00:49Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "conversationalSummarizationResults",
"lastUpdateDateTime": "2022-04-01T15:00:49Z",
"taskName": "Conversation Summarization Task 1",
"status": "succeeded",
"results": {
"conversations": [
{
"id": "1",
"summaries": [
{
"aspect": "chapterTitle",
"text": "Bug Triage",
"contexts": [
{
"conversationItemId": "2",
"offset": 4,
"length": 39
}
]
},
{
"aspect": "narrative",
"text": "Speaker 3 believes there are 3 remaining bugs.",
"contexts": [
{
"conversationItemId": "2",
"offset": 4,
"length": 39
},
{
"conversationItemId": "3",
"offset": 0,
"length": 7
}
]
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "latest"
}
}
]
},
"nextLink": "<resource-endpoint>/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10"
}
SuccessfulConversationSummarizationTaskStatusRequest
Solicitação de exemplo
GET {Endpoint}/language/analyze-conversations/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01
Resposta de exemplo
{
"displayName": "Analyze chat",
"createdDateTime": "2022-04-01T15:00:45Z",
"expirationDateTime": "2022-04-02T15:00:45Z",
"jobId": "3e9e8518-492f-47f9-abd1-9a7468231086",
"lastUpdatedDateTime": "2022-04-01T15:00:49Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "conversationalSummarizationResults",
"lastUpdateDateTime": "2022-04-01T15:00:49Z",
"taskName": "analyze 1",
"status": "succeeded",
"results": {
"conversations": [
{
"id": "20220101meeting",
"summaries": [
{
"aspect": "issue",
"text": "Customer wants to cancel his subscription. Customer doesn't know how"
},
{
"aspect": "resolution",
"text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription"
}
],
"warnings": [],
"statistics": {
"transactionsCount": 1
}
}
],
"errors": [],
"modelVersion": "latest"
}
}
]
},
"nextLink": "<resource-endpoint>/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10"
}
Definições
Nome | Description |
---|---|
Analyze |
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas. |
Analyze |
Contém o status do trabalho enviado para analisar uma conversa, juntamente com estatísticas relacionadas. |
Analyze |
Enumeração de resultados para resultados de análise de conversa com suporte. |
Analyze |
Resultado da tarefa de resumo na conversa. |
Audio |
Informações de tempo de áudio. |
Conversational |
Item de resultado de PII de conversa |
Conversation |
O resultado da operação de detecção e redação de PII para cada conversa. |
Conversation |
O resultado da operação de detecção e redação de PII para cada conversa. |
Conversation |
se showStats=true foi especificado na solicitação, esse campo contém informações sobre o conteúdo da solicitação. |
Conversations |
Resultado do Resumo de Conversas |
Conversation |
Se showStats=true foi especificado na solicitação, esse campo contém informações sobre o conteúdo da conversa. |
Document |
Contém detalhes dos erros encontrados durante uma execução de trabalho. |
Entity |
Texto categorizado em classes ou tipos predefinidos, como: pessoa, localização, evento, produto e organização. |
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Inner |
Código de erro legível por humanos. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Input |
Contém detalhes dos avisos encontrados durante uma execução de trabalho. |
Itemized |
Contexto do resumo com uma ID de item de conversa. |
Redacted |
Resposta de conteúdo de transcrição gerada pelo serviço, com todas as informações de identificação pessoal necessárias redigidas. |
Request |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
State |
O status da tarefa na hora da última atualização mencionada. |
Summary |
Resultados de Resumo |
Summary |
Item de resultado de resumo |
Tasks |
Contém o estado das tarefas que estão sendo executadas como parte do trabalho enviado para analisar uma conversa. |
AnalyzeConversationConversationPiiResult
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas.
Nome | Tipo | Description |
---|---|---|
kind |
string:
conversational |
tipo discriminatório |
lastUpdateDateTime |
string (date-time) |
A última hora atualizada em UTC para a tarefa. |
results |
Resultados |
|
status |
O status da tarefa na hora da última atualização mencionada. |
|
taskName |
string |
nome da tarefa |
AnalyzeConversationJobState
Contém o status do trabalho enviado para analisar uma conversa, juntamente com estatísticas relacionadas.
Nome | Tipo | Description |
---|---|---|
createdDateTime |
string (date-time) |
Trabalho de data e hora criado |
displayName |
string |
nome de exibição |
errors |
Error[] |
Erros |
expirationDateTime |
string (date-time) |
O trabalho de data e hora expira |
jobId |
string (uuid) |
ID do trabalho |
lastUpdatedDateTime |
string (date-time) |
data e hora da última atualização |
nextLink |
string |
próximo link |
statistics |
Contém as estatísticas do trabalho enviado. |
|
status |
estado |
|
tasks |
Contém o estado das tarefas que estão sendo executadas como parte do trabalho enviado para analisar uma conversa. |
AnalyzeConversationResultsKind
Enumeração de resultados para resultados de análise de conversa com suporte.
Valor | Description |
---|---|
conversationalPIIResults |
Resultados de PII de conversação |
conversationalSummarizationResults |
Resultados de resumo de conversa |
AnalyzeConversationSummarizationResult
Resultado da tarefa de resumo na conversa.
Nome | Tipo | Description |
---|---|---|
kind |
string:
conversational |
tipo discriminatório |
lastUpdateDateTime |
string (date-time) |
A última hora atualizada em UTC para a tarefa. |
results |
Resultados |
|
status |
O status da tarefa na hora da última atualização mencionada. |
|
taskName |
string |
nome da tarefa |
AudioTiming
Informações de tempo de áudio.
Nome | Tipo | Description |
---|---|---|
duration |
integer (int64) |
Duração da articulação de palavras, em tiques. 1 tique = 100 nanossegundos. |
offset |
integer (int64) |
Deslocamento do início do áudio de fala, em tiques. 1 tique = 100 nanossegundos. |
ConversationalPiiResultWithResultBase
Item de resultado de PII de conversa
Nome | Tipo | Description |
---|---|---|
conversationItems |
Lista de conversationItems |
|
id |
string |
Identificador de conversa exclusivo e não vazio. |
statistics |
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa. |
|
warnings |
Avisos encontrados no processamento do documento. |
ConversationPiiItemResult
O resultado da operação de detecção e redação de PII para cada conversa.
Nome | Tipo | Description |
---|---|---|
entities |
Entity[] |
Matriz de entidades |
id |
string |
ID do resultado |
redactedContent |
Resposta de conteúdo de transcrição gerada pelo serviço, com todas as informações de identificação pessoal necessárias redigidas. |
ConversationPiiResults
O resultado da operação de detecção e redação de PII para cada conversa.
Nome | Tipo | Description |
---|---|---|
conversations |
matriz de conversas |
|
errors |
Erros por ID do documento. |
|
modelVersion |
string |
Esse campo indica qual modelo é usado para pontuação. |
statistics |
estatística |
ConversationRequestStatistics
se showStats=true foi especificado na solicitação, esse campo contém informações sobre o conteúdo da solicitação.
Nome | Tipo | Description |
---|---|---|
conversationsCount |
integer (int32) |
Número de conversas enviadas na solicitação. |
documentsCount |
integer (int32) |
Número de documentos enviados na solicitação. |
erroneousConversationsCount |
integer (int32) |
Número de documentos inválidos. Isso inclui documentos vazios, acima do limite de tamanho ou em idiomas sem suporte. |
erroneousDocumentsCount |
integer (int32) |
Número de documentos inválidos. Isso inclui documentos de idiomas vazios, de tamanho excessivo ou sem suporte. |
transactionsCount |
integer (int64) |
Número de transações para a solicitação. |
validConversationsCount |
integer (int32) |
Número de documentos de conversa. Isso exclui documentos vazios, acima do limite de tamanho ou em idiomas sem suporte. |
validDocumentsCount |
integer (int32) |
Número de documentos válidos. Isso exclui documentos de idiomas vazios, de tamanho excessivo ou não compatíveis. |
ConversationsSummaryResult
Resultado do Resumo de Conversas
Nome | Tipo | Description |
---|---|---|
id |
string |
Identificador de conversa exclusivo e não vazio. |
statistics |
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa. |
|
summaries |
matriz de resumos |
|
warnings |
Avisos encontrados no processamento do documento. |
ConversationStatistics
Se showStats=true foi especificado na solicitação, esse campo contém informações sobre o conteúdo da conversa.
Nome | Tipo | Description |
---|---|---|
transactionsCount |
integer (int32) |
Número de unidades de texto para a solicitação. |
DocumentError
Contém detalhes dos erros encontrados durante uma execução de trabalho.
Nome | Tipo | Description |
---|---|---|
error |
Erro encontrado. |
|
id |
string |
A ID do documento de entrada. |
Entity
Texto categorizado em classes ou tipos predefinidos, como: pessoa, localização, evento, produto e organização.
Nome | Tipo | Description |
---|---|---|
category |
string |
Tipo de entidade. |
confidenceScore |
number (double) |
Pontuação de confiança entre 0 e 1 da entidade extraída. |
length |
integer (int32) |
Comprimento do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado. |
offset |
integer (int32) |
Posição inicial do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado. |
subcategory |
string |
(Opcional) Subtipo de entidade. |
text |
string |
Texto da entidade conforme aparece na solicitação. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Uma representação legível pelo ser humano do erro. |
target |
string |
O destino do erro. |
ErrorCode
Código de erro legível por humanos.
Valor | Description |
---|---|
AzureCognitiveSearchIndexLimitReached |
Erro atingido no limite de índice do Azure Cognitive Search |
AzureCognitiveSearchIndexNotFound |
Erro não encontrado no índice do Azure Cognitive Search |
AzureCognitiveSearchNotFound |
Erro não encontrado no Azure Cognitive Search |
AzureCognitiveSearchThrottling |
Erro de limitação do Azure Cognitive Search |
Conflict |
Erro de conflito |
Forbidden |
Erro de acesso proibido |
InternalServerError |
Erro interno do servidor |
InvalidArgument |
Erro de argumento inválido |
InvalidRequest |
Erro de solicitação inválido |
NotFound |
Erro não encontrado |
OperationNotFound |
Erro de operação não encontrada |
ProjectNotFound |
Erro não encontrado no projeto |
QuotaExceeded |
Erro de cota excedido |
ServiceUnavailable |
Erro de serviço indisponível |
Timeout |
Erro de tempo limite |
TooManyRequests |
Erro de muitas solicitações |
Unauthorized |
Erro de acesso não autorizado |
Warning |
Erro de aviso |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
InnerErrorCode
Código de erro legível por humanos.
Valor | Description |
---|---|
AzureCognitiveSearchNotFound |
Erro não encontrado no Azure Cognitive Search |
AzureCognitiveSearchThrottling |
Erro de limitação do Azure Cognitive Search |
EmptyRequest |
Erro de solicitação vazia |
ExtractionFailure |
Erro de falha de extração |
InvalidCountryHint |
Erro de dica de país inválido |
InvalidDocument |
Erro de documento inválido |
InvalidDocumentBatch |
Erro em lote de documento inválido |
InvalidParameterValue |
Erro de valor de parâmetro inválido |
InvalidRequest |
Erro de solicitação inválido |
InvalidRequestBodyFormat |
Erro de formato do corpo da solicitação inválido |
KnowledgeBaseNotFound |
Erro não encontrado na base de dados de conhecimento |
MissingInputDocuments |
Erro de documentos de entrada ausentes |
ModelVersionIncorrect |
Erro incorreto da versão do modelo |
UnsupportedLanguageCode |
Erro de código de idioma sem suporte |
InnerErrorModel
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
object |
Detalhes do erro. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino de erro. |
InputWarning
Contém detalhes dos avisos encontrados durante uma execução de trabalho.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de aviso. |
message |
string |
Mensagem de aviso. |
targetRef |
string |
Uma referência de ponteiro JSON que indica o objeto de destino. |
ItemizedSummaryContext
Contexto do resumo com uma ID de item de conversa.
Nome | Tipo | Description |
---|---|---|
conversationItemId |
string |
Referência à ID do ConversationItem. |
length |
integer (int32) |
O comprimento do contexto. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado. |
offset |
integer (int32) |
Posição inicial para o contexto. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado. |
RedactedTranscriptContent
Resposta de conteúdo de transcrição gerada pelo serviço, com todas as informações de identificação pessoal necessárias redigidas.
Nome | Tipo | Description |
---|---|---|
audioTimings |
Lista de segmentos de áudio redigidos. |
|
itn |
string |
Saída redigida para entrada no formato normalizado de texto inverso. |
lexical |
string |
Saída redigida para entrada no formato lexical. |
maskedItn |
string |
Saída redigida para entrada no formato de inverso mascarado normalizado por texto. |
text |
string |
Saída redigida para entrada em texto (formato de conversão de fala em texto da Microsoft 'display'). |
RequestStatistics
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação.
Nome | Tipo | Description |
---|---|---|
documentsCount |
integer (int32) |
Número de documentos enviados na solicitação. |
erroneousDocumentsCount |
integer (int32) |
Número de documentos inválidos. Isso inclui documentos de idiomas vazios, de tamanho excessivo ou sem suporte. |
transactionsCount |
integer (int64) |
Número de transações para a solicitação. |
validDocumentsCount |
integer (int32) |
Número de documentos válidos. Isso exclui documentos de idiomas vazios, de tamanho excessivo ou não compatíveis. |
State
O status da tarefa na hora da última atualização mencionada.
Valor | Description |
---|---|
cancelled |
Estado cancelado |
cancelling |
Cancelando o estado |
failed |
Estado com falha |
notStarted |
Estado não iniciado |
partiallyCompleted |
Estado parcialmente concluído |
running |
Estado em execução |
succeeded |
Estado bem-sucedido |
SummaryResult
Resultados de Resumo
Nome | Tipo | Description |
---|---|---|
conversations |
matriz de conversas |
|
errors |
Erros por ID do documento. |
|
modelVersion |
string |
Esse campo indica qual modelo é usado para pontuação. |
statistics |
estatística |
SummaryResultItem
Item de resultado de resumo
Nome | Tipo | Description |
---|---|---|
aspect |
string |
aspecto |
contexts |
Lista de contexto do resumo. |
|
text |
string |
Texto |
Tasks
Contém o estado das tarefas que estão sendo executadas como parte do trabalho enviado para analisar uma conversa.
Nome | Tipo | Description |
---|---|---|
completed |
integer (int32) |
Contagem de tarefas que foram concluídas com êxito. |
failed |
integer (int32) |
Contagem de tarefas que falharam. |
inProgress |
integer (int32) |
Contagem de tarefas que estão em andamento no momento. |
items | AnalyzeConversationJobResult[]: |
Lista de resultados de tarefas (se disponível). |
total |
integer (int32) |
Contagem total de tarefas enviadas como parte do trabalho. |