Text Analysis Authoring - Get Project
Hämtar information om ett projekt.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Cognitive Services-slutpunkt som stöds, t.ex. https://.api.cognitiveservices.azure.com. |
project
|
path | True |
string |
Det nya projektnamnet. |
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Begäran har slutförts. |
|
Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
Ocp-Apim-Subscription-Key
Typ:
apiKey
I:
header
OAuth2Auth
Typ:
oauth2
Flow:
accessCode
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress:
https://login.microsoftonline.com/common/oauth2/token
Omfattningar
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exempel
SuccessfulGetProject
Exempelbegäran
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01
Exempelsvar
{
"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"
}
Definitioner
Name | Description |
---|---|
Error |
Felobjektet. |
Error |
Felkod som kan läsas av människor. |
Error |
Felsvar. |
Inner |
Felkod som kan läsas av människor. |
Inner |
Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
|
Project |
Representerar de inställningar som används för att definiera projektbeteendet. |
Text |
Representerar metadata för ett projekt. |
Error
Felobjektet.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
Error[] |
En matris med information om specifika fel som ledde till det rapporterade felet. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
En mänsklig läsbar representation av felet. |
target |
string |
Målet för felet. |
ErrorCode
Felkod som kan läsas av människor.
Name | Typ | 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
Felsvar.
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
InnerErrorCode
Felkod som kan läsas av människor.
Name | Typ | 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
Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
object |
Felinformation. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
Felmeddelande. |
target |
string |
Felmål. |
ProjectKind
Name | Typ | Description |
---|---|---|
CustomEntityRecognition |
string |
För att skapa en extraheringsmodell för att identifiera dina domänkategorier med dina egna data. |
CustomMultiLabelClassification |
string |
För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil kan ha en eller flera etiketter. Till exempel klassificeras fil 1 som A, B och C och fil 2 klassificeras som B och C. |
CustomSingleLabelClassification |
string |
För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil har bara en etikett. Till exempel klassificeras fil 1 som A och fil 2 klassificeras som B. |
ProjectSettings
Representerar de inställningar som används för att definiera projektbeteendet.
Name | Typ | Description |
---|---|---|
confidenceThreshold |
number |
Tröskelvärdet för klassen med högsta konfidens, där förutsägelsen automatiskt ändras till "Ingen". Värdet för tröskelvärdet ska vara mellan 0 och 1 inklusive. |
TextAnalysisAuthoringProjectMetadata
Representerar metadata för ett projekt.
Name | Typ | Description |
---|---|---|
createdDateTime |
string |
Representerar datumtid för projektskapande. |
description |
string |
Projektbeskrivningen. |
language |
string |
Projektspråket. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv. |
lastDeployedDateTime |
string |
Representerar projektets senaste distributionsdatumtid. |
lastModifiedDateTime |
string |
Representerar projektets senaste ändringsdatumtid. |
lastTrainedDateTime |
string |
Representerar projektets senaste träningsdatumtid. |
multilingual |
boolean |
Om projektet skulle användas för flera språk eller inte. |
projectKind |
Projekttypen. |
|
projectName |
string |
Det nya projektnamnet. |
settings |
Projektinställningarna. |
|
storageInputContainerName |
string |
Namnet på lagringscontainern. |