Text Analysis Authoring - List Projects
Listas os projetos existentes.
GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&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). |
api-version
|
query | True |
string |
Versão da API de Cliente. |
maxpagesize
|
query |
integer int32 |
O número máximo de recursos a incluir numa única resposta. |
|
skip
|
query |
integer int32 |
Um desvio para a coleção do primeiro recurso a ser devolvido. |
|
top
|
query |
integer int32 |
O número máximo de recursos a devolver da coleção. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Os metadados dos projetos. |
|
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 recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.
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 o Trabalho, a Escola e os 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 List Projects
Sample Request
GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01
Sample Response
{
"value": [
{
"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"
},
{
"createdDateTime": "2022-04-18T14:03:12Z",
"lastModifiedDateTime": "2022-04-18T14:03:12Z",
"projectKind": "CustomMultiLabelClassification",
"storageInputContainerName": "loanagreements",
"projectName": "MoviesSummary",
"multilingual": false,
"description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".",
"language": "en"
}
],
"nextLink": null
}
Definições
Name | Description |
---|---|
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
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. |
Project |
O tipo de projeto. |
Text |
Representa os metadados de um projeto. |
Text |
Representa as definições utilizadas para definir o comportamento do projeto. |
Text |
Representa uma lista dos metadados dos projetos obtidos. |
Error
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
|
details |
Error[] |
Uma série de detalhes sobre erros específicos que levaram a este erro comunicado. |
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. |
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. |
ProjectKind
O tipo de projeto.
Name | Tipo | Description |
---|---|---|
CustomEntityRecognition |
string |
Para criar um modelo de extração para identificar as categorias de domínio com os seus próprios dados. |
CustomMultiLabelClassification |
string |
Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro pode ter uma ou muitas etiquetas. Por exemplo, o ficheiro 1 é classificado como A, B e C e o ficheiro 2 é classificado como B e C. |
CustomSingleLabelClassification |
string |
Para criar um modelo de classificação para classificar texto com os seus próprios dados. Cada ficheiro terá apenas uma etiqueta. Por exemplo, o ficheiro 1 é classificado como A e o ficheiro 2 é classificado como B. |
TextAnalysisAuthoringProjectMetadata
Representa os metadados de um projeto.
Name | Tipo | Description |
---|---|---|
createdDateTime |
string |
Representa o datetime de criação do projeto. |
description |
string |
A descrição do projeto. |
language |
string |
A linguagem do projeto. Esta é a representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
lastDeployedDateTime |
string |
Representa o data/hora da última implementação do projeto. |
lastModifiedDateTime |
string |
Representa o datetime da última modificação do projeto. |
lastTrainedDateTime |
string |
Representa o último datetime de preparação do projeto. |
multilingual |
boolean |
Se o projeto seria ou não utilizado para vários idiomas. |
projectKind |
O tipo de projeto. |
|
projectName |
string |
O novo nome do projeto. |
settings |
As definições do projeto. |
|
storageInputContainerName |
string |
O nome do contentor de armazenamento. |
TextAnalysisAuthoringProjectSettings
Representa as definições utilizadas para definir o comportamento do projeto.
Name | Tipo | Description |
---|---|---|
confidenceThreshold |
number |
O limiar da classe com maior confiança, no qual a predição será automaticamente alterada para "Nenhum". O valor do limiar deve ser entre 0 e 1 inclusive. |
TextAnalysisAuthoringProjectsMetadata
Representa uma lista dos metadados dos projetos obtidos.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
A ligação da página seguinte. |
value |
A lista de projetos. |