Text Analysis Authoring - Get Project

Referentie

Service:: Cognitive Services - Language

API-versie:: 2023-04-01

Hiermee haalt u de details van een project op.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	TextAnalysisAuthoringProjectMetadata	De metagegevens van het project.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Get Project

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Het soort project.
TextAnalysisAuthoringProjectMetadata	Vertegenwoordigt de metagegevens van een project.
TextAnalysisAuthoringProjectSettings	Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

ProjectKind

Het soort project.

Name	Type	Description
CustomEntityRecognition	string	Voor het bouwen van een extractiemodel om uw domeincategorieën te identificeren met behulp van uw eigen gegevens.
CustomMultiLabelClassification	string	Voor het bouwen van een classificatiemodel om tekst te classificeren met behulp van uw eigen gegevens. Elk bestand kan een of meer labels hebben. Bestand 1 is bijvoorbeeld geclassificeerd als A, B en C en bestand 2 is geclassificeerd als B en C.
CustomSingleLabelClassification	string	Voor het bouwen van een classificatiemodel om tekst te classificeren met behulp van uw eigen gegevens. Elk bestand heeft slechts één label. Bestand 1 is bijvoorbeeld geclassificeerd als A en bestand 2 is geclassificeerd als B.

TextAnalysisAuthoringProjectMetadata

Vertegenwoordigt de metagegevens van een project.

Name	Type	Description
createdDateTime	string	Vertegenwoordigt de datum waarop het project is gemaakt.
description	string	De projectbeschrijving.
language	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
lastDeployedDateTime	string	Vertegenwoordigt de datum/tijd van de laatste implementatie van het project.
lastModifiedDateTime	string	Vertegenwoordigt de datum/tijd van de laatste wijziging van het project.
lastTrainedDateTime	string	Vertegenwoordigt de datum/tijd van de laatste training van het project.
multilingual	boolean	Of het project voor meerdere talen wordt gebruikt of niet.
projectKind	ProjectKind	Het soort project.
projectName	string	De nieuwe projectnaam.
settings	TextAnalysisAuthoringProjectSettings	De projectinstellingen.
storageInputContainerName	string	De naam van de opslagcontainer.

TextAnalysisAuthoringProjectSettings

Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.

Name	Type	Description
confidenceThreshold	number	De drempelwaarde van de klasse met de hoogste betrouwbaarheid, waarbij de voorspelling automatisch wordt gewijzigd in 'Geen'. De waarde van de drempelwaarde moet tussen 0 en 1 liggen.

Delen via