Conversational Analysis Authoring - List Trained Models

Referentie

Service:: Cognitive Services - Language

API-versie:: 2023-04-01

Lijsten de getrainde modellen die bij een project horen.

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

Met optionele parameters:

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-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	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.
maxpagesize	query		integer int32	Het maximum aantal resources dat in één antwoord moet worden opgenomen.
skip	query		integer int32	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
top	query		integer int32	Het maximum aantal resources dat uit de verzameling moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectTrainedModels	Lijst met alle getrainde modellen.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful List Models

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "label": "model1",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49Z",
      "lastTrainingDurationInSeconds": 186,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    },
    {
      "label": "model2",
      "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
      "lastTrainedDateTime": "2022-04-18T17:25:22Z",
      "lastTrainingDurationInSeconds": 192,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    }
  ],
  "nextLink": null
}

Definities

Name	Description
ConversationalAnalysisAuthoringProjectTrainedModel	Vertegenwoordigt een getraind model.
ConversationalAnalysisAuthoringProjectTrainedModels	Vertegenwoordigt een lijst met opgehaalde getrainde modellen.
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere 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.

ConversationalAnalysisAuthoringProjectTrainedModel

Vertegenwoordigt een getraind model.

Name	Type	Description
hasSnapshot	boolean	De vlag om aan te geven of het getrainde model een momentopname gereed heeft.
label	string	Het label getrainde model.
lastTrainedDateTime	string	De laatst getrainde datum/tijd van het model.
lastTrainingDurationInSeconds	integer	De duur van de laatste trainingsaanvraag van het model in seconden.
modelExpirationDate	string	De vervaldatum van het model.
modelId	string	De model-id.
modelTrainingConfigVersion	string	De configuratieversie van de modeltraining.

ConversationalAnalysisAuthoringProjectTrainedModels

Vertegenwoordigt een lijst met opgehaalde getrainde modellen.

Name	Type	Description
nextLink	string	De koppeling naar de volgende pagina.
value	ConversationalAnalysisAuthoringProjectTrainedModel[]	De lijst met opgehaalde taken.

Error

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

ErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode