Text Analysis Authoring - Train
Aciona uma tarefa de preparação para um projeto.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:train?api-version=2023-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
O nome do projeto a utilizar. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
modelLabel | True |
string |
Representa a etiqueta do modelo de saída. |
trainingConfigVersion | True |
string |
Representa a versão de configuração de preparação. |
evaluationOptions |
Representa as opções de avaliação. Por predefinição, o tipo de avaliação é percentagem, com percentagem de divisão de preparação como 80 e percentagem de divisão de teste como 20. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Headers operation-location: string |
|
Other Status Codes |
Resposta de erro. |
Segurança
AADToken
Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Notas
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.
O Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory.
* O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Uma chave de subscrição para um recurso do Serviço de idiomas.
Type:
apiKey
In:
header
Exemplos
Successful Train Project
Sample Request
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Sample Response
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definições
Name | Description |
---|---|
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Evaluation |
Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem. |
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Text |
Representa as opções utilizadas para executar a avaliação. |
Text |
Representa as opções para iniciar uma nova tarefa de formação. |
Error
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
|
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado. |
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 por humanos do erro. |
target |
string |
O destino 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 |
O objeto de erro. |
EvaluationKind
Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem.
Name | Tipo | Description |
---|---|---|
manual |
string |
Divida os dados de acordo com o conjunto de dados escolhido para cada exemplo nos dados. |
percentage |
string |
Divida os dados em conjuntos de preparação e teste de acordo com percentagens definidas pelo utilizador. |
InnerErrorCode
Código de erro legível por humanos.
Name | 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
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Tipo | Description |
---|---|---|
code |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
|
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 do erro. |
TextAnalysisAuthoringEvaluationOptions
Representa as opções utilizadas para executar a avaliação.
Name | Tipo | Description |
---|---|---|
kind |
Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem. |
|
testingSplitPercentage |
integer |
Representa a percentagem de divisão do conjunto de dados de teste. Só é necessário caso o tipo de avaliação seja percentagem. |
trainingSplitPercentage |
integer |
Representa a percentagem de divisão do conjunto de dados de preparação. Só é necessário caso o tipo de avaliação seja percentagem. |
TextAnalysisAuthoringTrainingJobOptions
Representa as opções para iniciar uma nova tarefa de formação.
Name | Tipo | Description |
---|---|---|
evaluationOptions |
Representa as opções de avaliação. Por predefinição, o tipo de avaliação é percentagem, com percentagem de divisão de preparação como 80 e percentagem de divisão de teste como 20. |
|
modelLabel |
string |
Representa a etiqueta do modelo de saída. |
trainingConfigVersion |
string |
Representa a versão de configuração de preparação. |