Text Analysis Authoring - Create Project

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

La operación más básica que se aplica a un recurso.

PATCH {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 url	Punto de conexión de Cognitive Services compatible, por ejemplo, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Nombre del nuevo proyecto.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Requerido	Tipo	Description
language	True	string	Lenguaje del proyecto. Esta es la 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.
projectKind	True	ProjectKind	Tipo de proyecto.
projectName	True	string	Nombre del nuevo proyecto.
storageInputContainerName	True	string	Nombre del contenedor de almacenamiento.
description		string	Descripción del proyecto.
multilingual		boolean	Si el proyecto se usaría para varios lenguajes o no.
settings		ProjectSettings	Configuración del proyecto.

Respuestas

Nombre	Tipo	Description
200 OK	TextAnalysisAuthoringProjectMetadata	La solicitud se ha realizado correctamente.
201 Created	TextAnalysisAuthoringProjectMetadata	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default

Ejemplos

Successful Create Project

Solicitud de ejemplo

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "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.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

Respuesta de muestra

status code:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "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"
}

status code:: 200

{
  "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.
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.
ProjectKind
ProjectSettings	Representa la configuración utilizada para definir el comportamiento del proyecto.
TextAnalysisAuthoringCreateProjectOptions	Representa las opciones usadas para crear o actualizar un proyecto.
TextAnalysisAuthoringProjectMetadata	Representa los metadatos de un proyecto.

Error

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

Código de error legible para personas.

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	Error	Objeto de error.

InnerErrorCode

Código de error legible para personas.

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	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.

ProjectKind

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 mediante 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 mediante sus propios datos. Cada archivo solo tendrá una etiqueta. Por ejemplo, el archivo 1 se clasifica como A y el archivo 2 se clasifica como B.

ProjectSettings

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.