Een model implementeren en tekst classificeren met behulp van de runtime-API

Zodra u tevreden bent over hoe uw model presteert, is het klaar om te worden geïmplementeerd; en gebruik deze om tekst te classificeren. Het implementeren van een model maakt het beschikbaar voor gebruik via de voorspellings-API.

Vereisten

Bekijk de levenscyclus van projectontwikkeling.

Model implementeren (REST API)

Nadat u de prestaties van uw model hebt bekeken en hebt besloten dat het kan worden gebruikt in uw omgeving, moet u het toewijzen aan een implementatie om er query's op uit te voeren. Als u het model toewijst aan een implementatie, is het beschikbaar voor gebruik via de voorspellings-API. U wordt aangeraden een implementatie te maken met de naam production waaraan u het beste model toewijst dat u tot nu toe hebt gemaakt en dit in uw systeem te gebruiken. U kunt een andere implementatie staging maken waarmee u het model waaraan u momenteel werkt kunt toewijzen om het te testen. U kunt maximaal 10 implementaties in uw project hebben.

Implementatietaak verzenden

Dien een PUT-aanvraag in met behulp van de volgende URL, headers en JSON-hoofdtekst om een implementatietaak te verzenden. Vervang de tijdelijke aanduidingen door uw eigen waarden.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam van uw project. Deze waarde is hoofdlettergevoelig. myProject
{DEPLOYMENT-NAME} De naam van uw implementatie. Deze waarde is hoofdlettergevoelig. staging
{API-VERSION} De versie van de API die u aanroept. De waarde waarnaar wordt verwezen, is voor de nieuwste versie die is uitgebracht. Meer informatie over andere beschikbare API-versies 2022-05-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Aanvraagtekst

Gebruik de volgende JSON in de hoofdtekst van uw aanvraag. Gebruik de naam van het model dat u aan de implementatie wilt toewijzen.

{
  "trainedModelLabel": "{MODEL-NAME}"
}
Sleutel Tijdelijke aanduiding Weergegeven als Opmerking
trainedModelLabel {MODEL-NAME} De modelnaam die is toegewezen aan uw implementatie. U kunt alleen getrainde modellen toewijzen. Deze waarde is hoofdlettergevoelig. myModel

Zodra u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat de taak correct is verzonden. Pak in de antwoordheaders de operation-location waarde op die als volgt is opgemaakt:

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

{JOB-ID} wordt gebruikt om uw aanvraag te identificeren, omdat deze bewerking asynchroon is. U kunt deze URL gebruiken om de implementatiestatus op te halen.

Status van implementatietaak ophalen

Gebruik de volgende GET-aanvraag om de status van de implementatietaak op te vragen. U kunt de URL die u hebt ontvangen uit de vorige stap gebruiken of de tijdelijke aanduidingen vervangen door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam van uw project. Deze waarde is hoofdlettergevoelig. myProject
{DEPLOYMENT-NAME} De naam van uw implementatie. Deze waarde is hoofdlettergevoelig. staging
{JOB-ID} De id voor het zoeken naar de trainingsstatus van uw model. Deze bevindt zich in de location headerwaarde die u in de vorige stap hebt ontvangen. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} De versie van de API die u aanroept. De waarde waarnaar wordt verwezen, is voor de nieuwste versie die is uitgebracht. Meer informatie over andere beschikbare API-versies 2022-05-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst van antwoord

Zodra u de aanvraag hebt verzonden, krijgt u het volgende antwoord. Blijf dit eindpunt peilen totdat de statusparameter is gewijzigd in 'geslaagd'. U moet een 200 code ophalen om het succes van de aanvraag aan te geven.

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

Implementaties wisselen (REST API)

U kunt implementaties wisselen nadat u een model hebt getest dat is toegewezen aan één implementatie en deze wilt toewijzen aan een andere implementatie. Het wisselen van implementaties omvat het nemen van het model dat is toegewezen aan de eerste implementatie en het toewijzen ervan aan de tweede implementatie. Vervolgens neemt u het model dat is toegewezen aan de tweede implementatie en wijst u het toe aan de eerste implementatie. Deze stap kan worden gebruikt om uw production en staging-implementaties te wisselen wanneer u het model dat is toegewezen aan staging wilt toewijzen aan production.

Maak een POST-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om een wisselimplementatietaak te starten.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. De waarde waarnaar wordt verwezen, is voor de nieuwste modelversie die is uitgebracht. 2022-05-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Aanvraagbody

{
  "firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
  "secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}
Sleutel Tijdelijke aanduiding Weergegeven als Opmerking
firstDeploymentName {FIRST-DEPLOYMENT-NAME} De naam voor uw eerste implementatie. Deze waarde is hoofdlettergevoelig. production
secondDeploymentName {SECOND-DEPLOYMENT-NAME} De naam voor uw tweede implementatie. Deze waarde is hoofdlettergevoelig. staging

Zodra u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat het is gelukt.

Implementatie verwijderen (REST API)

Maak een DELETE-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om een implementatie te verwijderen.

Aanvraag-URL

{Endpoint}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{deploymentName}?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{DEPLOYMENT-NAME} De naam van uw implementatienaam. Deze waarde is hoofdlettergevoelig. prod
{API-VERSION} De versie van de API die u aanroept. De waarde waarnaar wordt verwezen, is voor de nieuwste versie die is uitgebracht. Meer informatie over andere beschikbare API-versies 2022-05-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Zodra u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat de implementatie is voltooid. Dit betekent dat uw implementatie wordt verwijderd. Een geslaagde aanroep met een Operation-Location header die wordt gebruikt om de status van de taak te controleren.

Implementatiebronnen toewijzen (REST API)

U kunt uw project implementeren in meerdere regio's door verschillende taalbronnen toe te wijzen die in verschillende regio's bestaan.

Voor het programmatisch toewijzen van implementatiebronnen is Microsoft Entra-verificatie vereist. Microsoft Entra-id wordt gebruikt om te bevestigen dat u toegang hebt tot de resources die u wilt toewijzen aan uw project voor implementatie in meerdere regio's. Als u programmatisch Microsoft Entra-verificatie wilt gebruiken bij het maken van REST API-aanroepen, vindt u meer informatie in de Foundry Tools-documentatie.

Resource toewijzen

Dien een POST-aanvraag in met behulp van de volgende URL, headers en JSON-hoofdtekst om implementatiebronnen toe te wijzen.

Aanvraag-URL

Gebruik de volgende URL bij het maken van uw API-aanvraag. Vervang de tijdelijke aanduidingen door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. 2022-10-01-preview

Kopteksten

Gebruik Microsoft Entra-verificatie om deze API te verifiëren.

Hoofdtekst

Gebruik de volgende voorbeeld-JSON als hoofdtekst.

{
  "resourcesMetadata": [
    {
      "azureResourceId": "{AZURE-RESOURCE-ID}",
      "customDomain": "{CUSTOM-DOMAIN}",
      "region": "{REGION-CODE}"
    }
  ]
}
Sleutel Tijdelijke aanduiding Weergegeven als Opmerking
azureResourceId {AZURE-RESOURCE-ID} Het volledige resource-id-pad dat u wilt toewijzen. Gevonden in Azure Portal op het tabblad Eigenschappen voor de resource, in het veld Resource-id . /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource
customDomain {CUSTOM-DOMAIN} Het aangepaste subdomein van de resource die u wilt toewijzen. Gevonden in Azure Portal op het tabblad Sleutels en eindpunt voor de resource, als het veld Eindpunt in de URL https://<your-custom-subdomain>.cognitiveservices.azure.com/ contosoresource
region {REGION-CODE} Een regiocode die de regio aangeeft van de resource die u wilt toewijzen. Gevonden in Azure Portal op het tabblad Sleutels en eindpunt voor de resource, in het veld Locatie/regio . eastus

Resourcestatus toewijzen ophalen

Gebruik de volgende GET-aanvraag om de status van uw implementatieresourcetaak op te halen. Vervang de tijdelijke aanduidingen door uw eigen waarden.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/assign/jobs/{JOB-ID}?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{JOB-ID} De taak-id voor het ophalen van de implementatiestatus van uw toewijzing. Deze bevindt zich in de operation-location headerwaarde die u van de API hebt ontvangen als reactie op uw toewijzingsresourceaanvraag voor de implementatie. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} De versie van de API die u aanroept. 2022-10-01-preview

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst van antwoord

Zodra u de aanvraag hebt verzonden, krijgt u het volgende antwoord. Polling van dit eindpunt houden totdat de status parameter wordt gewijzigd succeededin .

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

Toewijzingen van implementatiebronnen ongedaan maken (REST API)

Wanneer u een implementatieresource uit een project verwijdert of verwijdert, verwijdert u ook alle implementaties die eerder in die resourceregio zijn geïmplementeerd.

Resource intrekken

Dien een POST-aanvraag in met behulp van de volgende URL, headers en JSON-hoofdtekst om implementatiebronnen uit uw project uit te schakelen of te verwijderen.

Aanvraag-URL

Gebruik de volgende URL bij het maken van uw API-aanvraag. Vervang de tijdelijke aanduidingen door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. 2022-10-01-preview

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst

Gebruik de volgende voorbeeld-JSON als hoofdtekst.

{
  "assignedResourceIds": [
    "{AZURE-RESOURCE-ID}"
  ]
}
Sleutel Tijdelijke aanduiding Weergegeven als Opmerking
assignedResourceIds {AZURE-RESOURCE-ID} Het volledige resource-id-pad dat u wilt intrekken. Gevonden in Azure Portal op het tabblad Eigenschappen voor de resource als het veld Resource-id . /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource

Resourcestatus intrekken

Gebruik de volgende GET-aanvraag om de status van uw taak voor het ongedaan maken van implementatiebronnen op te halen. Vervang de tijdelijke aanduidingen door uw eigen waarden.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/unassign/jobs/{JOB-ID}?api-version={API-VERSION}
Tijdelijke aanduiding Weergegeven als Opmerking
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{JOB-ID} De taak-id voor het ophalen van de implementatiestatus van uw toewijzing. Deze bevindt zich in de operation-location headerwaarde die u van de API hebt ontvangen als reactie op uw verzoek om de implementatiesamenstellingsbron los te koppelen. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} De versie van de API die u aanroept. 2022-10-01-preview

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Weergegeven als
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst van antwoord

Zodra u de aanvraag hebt verzonden, krijgt u het volgende antwoord. Blijf dit eindpunt peilen totdat de statusparameter is gewijzigd in 'geslaagd'.

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

Volgende stappen