Conversational Analysis Authoring - Get Project

Szolgáltatás:

Azure AI Services

API-verzió:

2022-05-01

Lekéri egy projekt részleteit.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2022-05-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services végpont (például https:// resource-name.api.cognitiveservices.azure.com<>).
projectName	path	True	string maxLength: 100	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Nyelvi szolgáltatási erőforrás előfizetési kulcsa.

Válaszok

Name	Típus	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	A projekt metaadatai.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Nyelvi szolgáltatási erőforrás előfizetési kulcsa.

Típus: apiKey
In: header

Példák

Successful Get Project

Mintakérelem

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01

Mintaválasz

Állapotkód:

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": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definíciók

Name	Description
ConversationalAnalysisAuthoringProjectMetadata	Egy projekt metaadatait jelöli.
ConversationalAnalysisAuthoringProjectSettings	A projekt viselkedésének meghatározásához használt beállításokat jelöli.
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	A projekt típusát képviseli.

ConversationalAnalysisAuthoringProjectMetadata

Tárgy

Egy projekt metaadatait jelöli.

Name	Típus	Description
createdDateTime	string (date-time)	A projekt létrehozásának dátumidejét jelöli.
description	string	A projekt leírása.
language	string	A projekt nyelve. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
lastDeployedDateTime	string (date-time)	A projekt utolsó üzembe helyezésének dátumát jelöli.
lastModifiedDateTime	string (date-time)	A projekt létrehozásának dátumidejét jelöli.
lastTrainedDateTime	string (date-time)	A projekt utoljára betanított dátumát jelöli.
multilingual	boolean	Azt jelzi, hogy a projekt több nyelvre is használható-e.
projectKind	ProjectKind	A projekt típusát képviseli.
projectName	string	Az új projektnév.
settings	ConversationalAnalysisAuthoringProjectSettings	A projekt beállításai.

ConversationalAnalysisAuthoringProjectSettings

Tárgy

A projekt viselkedésének meghatározásához használt beállításokat jelöli.

Name	Típus	Description
confidenceThreshold	number (float)	A legnagyobb megbízhatósággal rendelkező szándék küszöbértéke, amelynél az előrejelzés automatikusan "Nincs" értékre módosul.

Error

Tárgy

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Tárgy

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

ProjectKind

Felsorolás

A projekt típusát képviseli.

Érték	Description
Conversation	Projekt, amely természetes nyelvet épít be alkalmazásokba, robotokba és IoT-eszközökbe.
Orchestration	A beszélgetés, az egyéni kérdésmegválaszolás és a LUIS-projektek egyetlen projektben történő összekapcsolására és vezénylésére szolgáló projekt.