Text Analysis Authoring - Get Project

Service:

Azure AI Services

API-versie:

2022-05-01

Hiermee haalt u de details van een project op.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2022-05-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 maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een Taalserviceresource.

Antwoorden

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

Beveiliging

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=2022-05-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	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke 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 projecttype.
TextAnalysisAuthoringProjectMetadata	Vertegenwoordigt de metagegevens van een project.

Error

Object

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 hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Een object met meer specifieke 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 meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

ProjectKind

Inventarisatie

Het projecttype.

Waarde	Description
CustomEntityRecognition	Voor het bouwen van een extractiemodel om uw domeincategorieën te identificeren met behulp van uw eigen gegevens.
CustomMultiLabelClassification	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	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 wordt geclassificeerd als B.

TextAnalysisAuthoringProjectMetadata

Object

Vertegenwoordigt de metagegevens van een project.

Name	Type	Description
createdDateTime	string (date-time)	Vertegenwoordigt de datum/tijd voor het maken van het project.
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 (date-time)	Vertegenwoordigt de datum/tijd van de laatste implementatie van het project.
lastModifiedDateTime	string (date-time)	Vertegenwoordigt de datum/tijd van de laatste wijziging van het project.
lastTrainedDateTime	string (date-time)	Vertegenwoordigt de datum/tijd van de laatste training van het project.
multilingual	boolean	Of het project nu wordt gebruikt voor meerdere talen of niet.
projectKind	ProjectKind	Het projecttype.
projectName	string	De naam van het nieuwe project.
settings	object	De projectinstellingen.
storageInputContainerName	string	De naam van de opslagcontainer.