Conversational Analysis Authoring - Get Project Deletion Status

Servicio:

Azure AI Services

Versión de la API:

2022-05-01

Obtiene el estado de un trabajo de eliminación de proyectos.

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}?api-version=2022-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Identificador del trabajo.
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Una clave de suscripción para un recurso de servicio de lenguaje.

Respuestas

Nombre	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectDeletionJobState	Resultado del trabajo de eliminación del proyecto.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful Get Project Deletion Status

Solicitud de ejemplo

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-05-01

Respuesta de muestra

status code:

200

{
  "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000",
  "createdDateTime": "2022-04-18T14:02:34Z",
  "lastUpdatedDateTime": "2022-04-18T14:02:34Z",
  "expirationDateTime": "2022-04-25T14:02:34Z",
  "status": "succeeded"
}

Definiciones

Nombre	Description
ConversationalAnalysisAuthoringProjectDeletionJobState	Representa el estado de un trabajo de eliminación de proyecto.
ConversationalAnalysisAuthoringWarning	Representa una advertencia que se encontró al ejecutar la solicitud.
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Estado del trabajo.

ConversationalAnalysisAuthoringProjectDeletionJobState

Object

Representa el estado de un trabajo de eliminación de proyecto.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Fecha de creación de la hora del trabajo.
errors	Error[]	Errores detectados al ejecutar el trabajo.
expirationDateTime	string (date-time)	Fecha de expiración del trabajo.
jobId	string	Identificador del trabajo.
lastUpdatedDateTime	string (date-time)	La última fecha en que se actualizó el trabajo.
status	JobStatus	Estado del trabajo.
warnings	ConversationalAnalysisAuthoringWarning[]	Advertencias que se encontraron al ejecutar el trabajo.

ConversationalAnalysisAuthoringWarning

Object

Representa una advertencia que se encontró al ejecutar la solicitud.

Nombre	Tipo	Description
code	string	El código de advertencia.
message	string	Mensaje de advertencia.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

JobStatus

Enumeración

Estado del trabajo.

Valor	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded