Dela via

Distribuera en modell och klassificera text med hjälp av körnings-API:et

När du är nöjd med hur din modell fungerar är den redo att distribueras. och använd den för att klassificera text. Om du distribuerar en modell blir den tillgänglig för användning via förutsägelse-API:et.

Förutsättningar

Se livscykeln för projektutveckling.

Distribuera modell (REST API)

När du har granskat modellens prestanda och bestämt att den kan användas i din miljö måste du tilldela den till en distribution för att kunna köra frågor mot den. Genom att tilldela modellen till en distribution blir den tillgänglig för användning via förutsägelse-API:et. Vi rekommenderar att du skapar en distribution med namnet production som du tilldelar den bästa modellen som du har skapat hittills och använder den i systemet. Du kan skapa en annan distribution med namnet staging som du kan tilldela den modell som du arbetar med för att kunna testa den. Du kan ha högst 10 distributioner i projektet.

Skicka distributionsjobb

Skicka en PUT-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att skicka ett distributionsjobb. Ersätt platshållarvärdena med dina egna värden.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{DEPLOYMENT-NAME} Namnet på distributionen. Det här värdet är skiftlägeskänsligt. staging
{API-VERSION} Den version av API:et som du anropar. Värdet som refereras är för den senaste versionen som släppts. Läs mer om andra tillgängliga API-versioner 2022-05-01

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Begärandetext

Använd följande JSON i brödtexten i din begäran. Använd namnet på den modell som du tilldelar distributionen.

{
  "trainedModelLabel": "{MODEL-NAME}"
}
Tangent Platshållare Värde Exempel
trainedModelLabel {MODEL-NAME} Modellnamnet som har tilldelats din distribution. Du kan bara tilldela modeller som tränats. Det här värdet är skiftlägeskänsligt. myModel

När du har skickat din API-begäran får du ett 202 svar som anger att jobbet har skickats korrekt. I svarshuvudena extraherar du värdet operation-location formaterat så här:

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

{JOB-ID} används för att identifiera din begäran, eftersom den här åtgärden är asynkron. Du kan använda den här URL:en för att hämta distributionsstatusen.

Hämta status för distributionsjobb

Använd följande GET-begäran för att fråga efter status för distributionsjobbet. Du kan använda den URL som du fick från föregående steg eller ersätta platshållarvärdena med dina egna värden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{DEPLOYMENT-NAME} Namnet på distributionen. Det här värdet är skiftlägeskänsligt. staging
{JOB-ID} ID:t för att hitta modellens träningsstatus. Det finns i det location rubrikvärde som du fick i föregående steg. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Den version av API:et som du anropar. Värdet som refereras är för den senaste versionen som släppts. Läs mer om andra tillgängliga API-versioner 2022-05-01

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Svarstext

När du har skickat begäran får du följande svar. Fortsätt att avsöka den här slutpunkten tills statusparametern ändras till "lyckades". Du bör få en 200 kod som anger att begäran har slutförts.

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

Växla utplaceringar (REST API)

Du kan växla distributioner efter att ha testat en modell som tilldelats en distribution och vill tilldela den till en annan. Att växla distributioner innebär att ta modellen som tilldelats den första distributionen och tilldela den till den andra distributionen. Ta sedan den modell som tilldelats till den andra distributionen och tilldela den till den första distributionen. Det här steget kan användas för att växla dina distributioner production och staging när du vill ta den modell som tilldelats staging och tilldela den till production.

Skapa en POST-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att starta ett växlingsdistributionsjobb.

Begärans-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{API-VERSION} Den version av API:et som du anropar. Värdet som refereras är för den senaste modellversionen som släppts. 2022-05-01

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Begärandetext

{
  "firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
  "secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}
Tangent Platshållare Värde Exempel
firstDeploymentName {FIRST-DEPLOYMENT-NAME} Namnet på din första distribution. Det här värdet är skiftlägeskänsligt. production
secondDeploymentName {SECOND-DEPLOYMENT-NAME} Namnet på din andra distribution. Det här värdet är skiftlägeskänsligt. staging

När du har skickat din API-begäran får du ett 202 svar som anger att det lyckades.

Ta bort distribution (REST API)

Skapa en DELETE-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att ta bort en distribution.

Begärans-URL

{Endpoint}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{deploymentName}?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{DEPLOYMENT-NAME} Namnet på distributionsnamnet. Det här värdet är skiftlägeskänsligt. prod
{API-VERSION} Den version av API:et som du anropar. Värdet som refereras är för den senaste versionen som släppts. Läs mer om andra tillgängliga API-versioner 2022-05-01

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

När du har skickat din API-begäran får du ett 202 svar som anger att det lyckades, vilket innebär att distributionen tas bort. Ett lyckat anrop resulterar i ett Operation-Location huvud som används för att kontrollera jobbets status.

Tilldela distributionsresurser (REST API)

Du kan distribuera projektet till flera regioner genom att tilldela olika språkresurser som finns i olika regioner.

Att tilldela distributionsresurser programmässigt kräver Microsoft Entra-autentisering. Microsoft Entra-ID används för att bekräfta att du har åtkomst till de resurser som du är intresserad av att tilldela projektet för distribution i flera regioner. Om du vill använda Microsoft Entra-autentisering programmatiskt när du gör REST API-anrop kan du läsa mer i dokumentationen om Foundry Tools.

Tilldela resurs

Skicka en POST-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att tilldela distributionsresurser.

Begärans-URL

Använd följande URL när du skapar din API-begäran. Ersätt platshållarvärdena med dina egna värden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{API-VERSION} Den version av API:et som du anropar. 2022-10-01-preview

Sidhuvuden

Använd Microsoft Entra-autentisering för att autentisera det här API:et.

Brödtext

Använd följande JSON-exempel som brödtext.

{
  "resourcesMetadata": [
    {
      "azureResourceId": "{AZURE-RESOURCE-ID}",
      "customDomain": "{CUSTOM-DOMAIN}",
      "region": "{REGION-CODE}"
    }
  ]
}
Tangent Platshållare Värde Exempel
azureResourceId {AZURE-RESOURCE-ID} Den fullständiga resurs-ID-sökvägen som du vill tilldela. Finns i Azure Portal under fliken Egenskaper för resursen i fältet Resurs-ID. /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource
customDomain {CUSTOM-DOMAIN} Den anpassade underdomänen för den resurs som du vill tilldela. Finns i Azure Portal under fliken Nycklar och slutpunkt för resursen som fältet Slutpunkt i URL:enhttps://<your-custom-subdomain>.cognitiveservices.azure.com/ contosoresource
region {REGION-CODE} En regionkod som anger regionen för den resurs som du vill tilldela. Finns i Azure Portal under fliken Nycklar och slutpunkt för resursen i fältet Plats/region. eastus

Hämta resursstatus

Använd följande GET-begäran för att hämta statusen för distributionsresursjobbet. Ersätt platshållarvärdena med dina egna värden.

Begärans-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/assign/jobs/{JOB-ID}?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{JOB-ID} Jobb-ID:t för att hämta distributionsstatusen för tilldelningen. Det finns i huvudvärdet operation-location som du fick från API:et som svar på din begäran om distributionsresurs. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Den version av API:et som du anropar. 2022-10-01-preview

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Svarstext

När du har skickat begäran får du följande svar. Fortsätt att avsöka den här slutpunkten tills parametern status ändras till succeeded.

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

Ta bort tilldelning av distributionsresurser (REST API)

När du avtilldelar eller tar bort en distributionsresurs från ett projekt tar du också bort alla distributioner som tidigare distribuerats till resursregionen.

Ta bort tilldelning av resurs

Skicka en POST-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att ta bort eller ta bort distributionsresurser från projektet.

Begärans-URL

Använd följande URL när du skapar din API-begäran. Ersätt platshållarvärdena med dina egna värden.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{API-VERSION} Den version av API:et som du anropar. 2022-10-01-preview

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Brödtext

Använd följande JSON-exempel som brödtext.

{
  "assignedResourceIds": [
    "{AZURE-RESOURCE-ID}"
  ]
}
Tangent Platshållare Värde Exempel
assignedResourceIds {AZURE-RESOURCE-ID} Den fullständiga resurs-ID-sökvägen som du vill ta bort tilldelningen av. Finns i Azure Portal under fliken Egenskaper för resursen som fältet Resurs-ID. /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource

Hämta avtilldela resursstatus

Använd följande GET-begäran för att hämta statusen för ditt avtilldela distributionsresursjobb. Ersätt platshållarvärdena med dina egna värden.

Begärans-URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/unassign/jobs/{JOB-ID}?api-version={API-VERSION}
Platshållare Värde Exempel
{ENDPOINT} Slutpunkten för att autentisera din API-begäran. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Namnet på projektet. Det här värdet är skiftlägeskänsligt. myProject
{JOB-ID} Jobb-ID:t för att hämta distributionsstatusen för tilldelningen. Det finns i det operation-location rubrikvärde som du fick från API:et som svar på din begäran om att inte tilldela distributionsresursen. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Den version av API:et som du anropar. 2022-10-01-preview

Sidhuvuden

Använd följande rubrik för att autentisera din begäran.

Tangent Värde
Ocp-Apim-Subscription-Key Nyckeln till resursen. Används för att autentisera dina API-begäranden.

Svarstext

När du har skickat begäran får du följande svar. Fortsätt att avsöka den här slutpunkten tills statusparametern ändras till "lyckades".

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

Nästa steg

  • Last updated on