Text Analysis Authoring - Create Project

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

A operação mais básica que se aplica a um recurso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string url	Ponto de extremidade dos Serviços Cognitivos suportados (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O novo nome do projeto.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
language	True	string	A linguagem do projeto. Esta é a representação BCP-47 de uma língua. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
projectKind	True	ProjectKind	O tipo de projeto.
projectName	True	string	O novo nome do projeto.
storageInputContainerName	True	string	O nome do contêiner de armazenamento.
description		string	A descrição do projeto.
multilingual		boolean	Se o projeto seria usado para vários idiomas ou não.
settings		ProjectSettings	As configurações do projeto.

Respostas

Name	Tipo	Description
200 OK	TextAnalysisAuthoringProjectMetadata	O pedido foi bem-sucedido.
201 Created	TextAnalysisAuthoringProjectMetadata	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Successful Create Project

Pedido de amostra

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"
}

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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"
}

Definições

Name	Description
CreateProjectOptions	Representa as opções usadas para criar ou atualizar um projeto.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
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.
ProjectKind
ProjectSettings	Representa as configurações usadas para definir o comportamento do projeto.
TextAnalysisAuthoringProjectMetadata	Representa os metadados de um projeto.

CreateProjectOptions

Representa as opções usadas para criar ou atualizar um projeto.

Name	Tipo	Description
description	string	A descrição do projeto.
language	string	A linguagem do projeto. Esta é a representação BCP-47 de uma língua. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
multilingual	boolean	Se o projeto seria usado para vários idiomas ou não.
projectKind	ProjectKind	O tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ProjectSettings	As configurações do projeto.
storageInputContainerName	string	O nome do contêiner de armazenamento.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	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 por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Código de erro legível por humanos.

Name	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

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode