Conversational Analysis Authoring - Get Project
Hämtar information om ett projekt.
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2023-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Namnet på det projekt som ska användas. |
api-version
|
query | True |
string |
Klient-API-version. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Projektets metadata. |
|
Other Status Codes |
Felsvar. |
Säkerhet
AADToken
Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer.
* Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
En prenumerationsnyckel för en språktjänstresurs.
Typ:
apiKey
I:
header
Exempel
Successful Get Project
Exempelbegäran
GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?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": "Conversation",
"projectName": "myproject",
"multilingual": false,
"description": "This is a sample conversation project.",
"language": "en"
}
Definitioner
Name | Description |
---|---|
Conversational |
Representerar metadata för ett projekt. |
Conversational |
Representerar de inställningar som används för att definiera projektbeteendet. |
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 Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Representerar projekttypen. |
ConversationalAnalysisAuthoringProjectMetadata
Representerar metadata för ett projekt.
Name | Typ | Description |
---|---|---|
createdDateTime |
string |
Representerar projektets skapandedatumtid. |
description |
string |
Projektbeskrivningen. |
language |
string |
Projektspråket. Detta ä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 projektet som senast distribuerades datetime. |
lastModifiedDateTime |
string |
Representerar projektets skapandedatumtid. |
lastTrainedDateTime |
string |
Representerar projektets senast tränade datetime. |
multilingual |
boolean |
Om projektet ska användas för flera språk eller inte. |
projectKind |
Representerar projekttypen. |
|
projectName |
string |
Det nya projektnamnet. |
settings |
Projektinställningarna. |
ConversationalAnalysisAuthoringProjectSettings
Representerar de inställningar som används för att definiera projektbeteendet.
Name | Typ | Description |
---|---|---|
confidenceThreshold |
number |
Tröskelvärdet för avsikten 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 inklusivt. |
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 Microsoft One API-riktlinjer – 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
Representerar projekttypen.
Name | Typ | Description |
---|---|---|
Conversation |
string |
Ett projekt för att bygga in naturligt språk i appar, robotar och IoT-enheter. |
Orchestration |
string |
Ett projekt för att ansluta och orkestrera konversations-, anpassade frågesvars- och LUIS-projekt tillsammans i ett enda projekt. |