Text Analysis Authoring - Get Project
Obtiene los detalles de un proyecto.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-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). |
project
|
path | True |
string |
Nombre del proyecto que se va a usar. |
api-version
|
query | True |
string |
Versión de API del cliente. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Metadatos del proyecto. |
|
Other Status Codes |
Respuesta de error. |
Seguridad
AADToken
Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
* El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Una clave de suscripción para un recurso de servicio de lenguaje.
Tipo:
apiKey
En:
header
Ejemplos
Successful Get Project
Solicitud de ejemplo
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01
Respuesta de muestra
{
"createdDateTime": "2022-04-18T13:53:03Z",
"lastModifiedDateTime": "2022-04-18T13:53:03Z",
"lastTrainedDateTime": "2022-04-18T14:14:28Z",
"lastDeployedDateTime": "2022-04-18T14:49:01Z",
"projectKind": "CustomEntityRecognition",
"storageInputContainerName": "loanagreements",
"projectName": "LoanAgreements",
"multilingual": false,
"description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
"language": "en"
}
Definiciones
Nombre | Description |
---|---|
Error |
Objeto de error. |
Error |
Código de error legible. |
Error |
Respuesta de error. |
Inner |
Código de error legible. |
Inner |
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. |
Project |
Tipo de proyecto. |
Text |
Representa los metadatos de un proyecto. |
Text |
Representa la configuración utilizada para definir el comportamiento del proyecto. |
Error
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
Uno de los conjuntos de códigos de error definidos por el servidor. |
|
details |
Error[] |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
innererror |
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
Código de error legible.
Nombre | Tipo | Description |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
InnerErrorCode
Código de error legible.
Nombre | Tipo | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
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.
Nombre | Tipo | Description |
---|---|---|
code |
Uno de los conjuntos de códigos de error definidos por el servidor. |
|
details |
object |
Detalles del error. |
innererror |
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. |
ProjectKind
Tipo de proyecto.
Nombre | Tipo | Description |
---|---|---|
CustomEntityRecognition |
string |
Para crear un modelo de extracción para identificar las categorías de dominio mediante sus propios datos. |
CustomMultiLabelClassification |
string |
Para crear un modelo de clasificación para clasificar texto con sus propios datos. Cada archivo puede tener una o varias etiquetas. Por ejemplo, el archivo 1 se clasifica como A, B y C y el archivo 2 se clasifican como B y C. |
CustomSingleLabelClassification |
string |
Para crear un modelo de clasificación para clasificar texto con sus propios datos. Cada archivo tendrá solo una etiqueta. Por ejemplo, el archivo 1 se clasifica como A y el archivo 2 se clasifica como B. |
TextAnalysisAuthoringProjectMetadata
Representa los metadatos de un proyecto.
Nombre | Tipo | Description |
---|---|---|
createdDateTime |
string |
Representa la fecha y hora de creación del proyecto. |
description |
string |
Descripción del proyecto. |
language |
string |
Lenguaje del proyecto. Se trata de una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc. |
lastDeployedDateTime |
string |
Representa la fecha y hora de la última implementación del proyecto. |
lastModifiedDateTime |
string |
Representa la fecha y hora de la última modificación del proyecto. |
lastTrainedDateTime |
string |
Representa la fecha y hora del último entrenamiento del proyecto. |
multilingual |
boolean |
Si el proyecto se usaría para varios lenguajes o no. |
projectKind |
Tipo de proyecto. |
|
projectName |
string |
Nuevo nombre del proyecto. |
settings |
Configuración del proyecto. |
|
storageInputContainerName |
string |
Nombre del contenedor de almacenamiento. |
TextAnalysisAuthoringProjectSettings
Representa la configuración utilizada para definir el comportamiento del proyecto.
Nombre | Tipo | Description |
---|---|---|
confidenceThreshold |
number |
Umbral de la clase con la mayor confianza, en la que la predicción se cambiará automáticamente a "None". El valor del umbral debe estar comprendido entre 0 y 1 inclusive. |