Dela via

Distribuera en arbetsflödesmodell för orkestrering

När du är nöjd med hur din modell fungerar är den redo att distribueras och fråga efter förutsägelser från yttranden. Om du distribuerar en modell blir den tillgänglig för användning via förutsägelse-API:et.

Förutsättningar

Mer information finns ilivscykeln för projektutveckling.

Distribuera en modell

När du har granskat modellens prestanda och bestämt att den passar bra för användning i din miljö måste du tilldela den till en distribution för att kunna ställa frågor till 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

Skapa en PUT-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att börja distribuera en arbetsflödesmodell för orkestrering.

Begärans-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}?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. 2023-04-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

{
  "trainedModelLabel": "{MODEL-NAME}",
}
Tangent Platshållare Värde Exempel
trainedModelLabel {MODEL-NAME} Modellnamnet som har tilldelats distributionen. 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 det lyckades. I svarshuvudena extraherar du värdet operation-location formaterat så här:

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

Du kan använda den här URL:en för att hämta distributionsjobbets status.

Hämta status för distributionsjobb

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

Begärans-URL

{ENDPOINT}/language/authoring/analyze-conversations/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 huvudvärdet location som du fick från API:et som svar på din modelldistributionsbegäran. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Den version av API:et som du anropar. 2023-04-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".

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

Växla distributioner

När du har testat en modell som tilldelats en distribution kanske du vill tilldela den till en annan distribution. Vid byte av distributioner ingår:

  • Ta modellen som tilldelats den första distributionen och tilldela den till den andra distributionen.
  • tar modellen som tilldelats till den andra distributionen och tilldelar den till den första distributionen.

Det här steget kan användas för att växla dina production och staging distributioner 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-conversations/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. 2023-04-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

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

Begärans-URL

{ENDPOINT}/language/authoring/analyze-conversations/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å distributionsnamnet. Det här värdet är skiftlägeskänsligt. staging
{API-VERSION} Den version av API:et som du anropar. 2023-04-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.

Tilldela distributionsresurser

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. Information om hur du programmatiskt använder Microsoft Entra-autentisering när du gör REST API-anrop finns i autentiseringsdokumentationen för 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-conversations/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, en del av 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 som en del av 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-conversations/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 statusparametern ändras till "lyckades".

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

Avtilldela distributionsresurser

När du avtilldelar eller tar bort en distributionsresurs från ett projekt kan du också ta bort alla distributioner som distribueras till den 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-conversations/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/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/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-conversations/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

Använda förutsägelse-API för att fråga din modell

  • Last updated on