Sdílet prostřednictvím


Conversational Analysis Authoring - List Deployments

Seznamy nasazení, která patří do projektu.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
Endpoint
path True

string

Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).

projectName
path True

string

Název projektu, který se má použít.

api-version
query True

string

Verze klientského rozhraní API

maxpagesize
query

integer

int32

Maximální počet prostředků, které se mají zahrnout do jedné odpovědi.

skip
query

integer

int32

Posun do kolekce prvního prostředku, který se má vrátit.

top
query

integer

int32

Maximální počet prostředků, které se mají vrátit z kolekce.

Odpovědi

Name Typ Description
200 OK

ConversationalAnalysisAuthoringProjectDeployments

Seznam všech nasazení

Other Status Codes

ErrorResponse

Odpověď na chybu.

Zabezpečení

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

  • Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Type: apiKey
In: header

Příklady

Successful List Deployments

Sample Request

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments?api-version=2023-04-01

Sample Response

{
  "value": [
    {
      "deploymentName": "production",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T16:03:51Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    },
    {
      "deploymentName": "staging",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T15:53:04Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    }
  ],
  "nextLink": null
}

Definice

Name Description
ConversationalAnalysisAuthoringProjectDeployment

Představuje nasazení projektu.

ConversationalAnalysisAuthoringProjectDeployments

Představuje seznam načtených nasazení.

Error

Objekt chyby.

ErrorCode

Kód chyby čitelný pro člověka.

ErrorResponse

Odpověď na chybu.

InnerErrorCode

Kód chyby čitelný pro člověka.

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringProjectDeployment

Představuje nasazení projektu.

Name Typ Description
deploymentExpirationDate

string

Představuje datum vypršení platnosti nasazení v modulu runtime.

deploymentName

string

Představuje název nasazení.

lastDeployedDateTime

string

Představuje čas posledního nasazení.

lastTrainedDateTime

string

Představuje čas posledního trénovaného nasazení.

modelId

string

Představuje id modelu nasazení.

modelTrainingConfigVersion

string

Představuje verzi konfigurace trénování modelu.

ConversationalAnalysisAuthoringProjectDeployments

Představuje seznam načtených nasazení.

Name Typ Description
nextLink

string

Odkaz na další stránku

value

ConversationalAnalysisAuthoringProjectDeployment[]

Seznam načtených nasazení

Error

Objekt chyby.

Name Typ Description
code

ErrorCode

Jeden ze serverem definované sady kódů chyb.

details

Error[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.

innererror

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

message

string

Lidsky čitelná reprezentace chyby.

target

string

Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

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

Odpověď na chybu.

Name Typ Description
error

Error

Objekt chyby.

InnerErrorCode

Kód chyby čitelný pro člověka.

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

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

InnerErrorCode

Jeden ze serverem definované sady kódů chyb.

details

object

Podrobnosti o chybě.

innererror

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

message

string

Chybová zpráva.

target

string

Cíl chyby.