Wdrażanie modelu i klasyfikowanie tekstu przy użyciu interfejsu API środowiska uruchomieniowego

Artykuł
11/21/2024

Gdy model jest zadowalający, jest gotowy do wdrożenia; i użyj go do klasyfikowania tekstu. Wdrożenie modelu udostępnia go do użycia za pośrednictwem interfejsu API przewidywania.

Wymagania wstępne

Niestandardowy projekt klasyfikacji tekstu ze skonfigurowanym kontem usługi Azure Storage,
Dane tekstowe przekazane na konto magazynu.
Dane oznaczone etykietą i pomyślnie wytrenowany model
Przejrzył szczegóły oceny modelu, aby określić, jak działa model.

Aby uzyskać więcej informacji, zobacz cykl projektowania projektu.

Wdrażanie modelu

Po przejrzeniu wydajności modelu i podjęciu decyzji, że może on być używany w danym środowisku, musisz przypisać go do wdrożenia, aby móc wykonywać względem niego zapytania. Przypisanie modelu do wdrożenia udostępnia go do użycia za pośrednictwem interfejsu API przewidywania. Zaleca się utworzenie wdrożenia o nazwie production , do którego przypisano najlepszy model utworzony do tej pory i użycie go w systemie. Możesz utworzyć kolejne wdrożenie o nazwie staging , do którego można przypisać model, nad którym pracujesz, aby móc go przetestować. W projekcie można mieć maksymalnie 10 wdrożeń.

Language Studio
Interfejsy API REST

Aby wdrożyć model z poziomu programu Language Studio:

Wybierz pozycję Deploying a model (Wdrażanie modelu ) z menu po lewej stronie.
Wybierz pozycję Dodaj wdrożenie , aby rozpocząć nowe zadanie wdrażania.
Wybierz pozycję Utwórz nowe wdrożenie, aby utworzyć nowe wdrożenie i przypisać wytrenowany model z poniższej listy rozwijanej. Możesz również zastąpić istniejące wdrożenie , wybierając tę opcję i wybierając wytrenowany model, który chcesz przypisać do niego z listy rozwijanej poniżej.

Uwaga

Zastępowanie istniejącego wdrożenia nie wymaga zmian wywołania interfejsu API przewidywania, ale uzyskane wyniki będą oparte na nowo przypisanym modelu.
wybierz pozycję Wdróż , aby uruchomić zadanie wdrożenia.
Po pomyślnym wdrożeniu obok zostanie wyświetlona data wygaśnięcia. Wygaśnięcie wdrożenia jest wtedy, gdy wdrożony model będzie niedostępny do przewidywania, co zwykle występuje dwanaście miesięcy po wygaśnięciu konfiguracji trenowania.

Przesyłanie zadania wdrożenia

Prześlij żądanie PUT przy użyciu następującego adresu URL, nagłówków i treści JSON, aby przesłać zadanie wdrożenia. Zastąp poniższe wartości symboli zastępczych własnymi wartościami.

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{DEPLOYMENT-NAME}`	Nazwa wdrożenia. Ta wartość jest uwzględniana w wielkości liter.	`staging`
`{API-VERSION}`	Wersja wywoływanego interfejsu API. Wartość, do których odwołuje się tutaj, dotyczy najnowszej wersji wydanej. Dowiedz się więcej o innych dostępnych wersjach interfejsu API	`2022-05-01`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść żądania

Użyj następującego kodu JSON w treści żądania. Użyj nazwy modelu, który chcesz przypisać do wdrożenia.

{
  "trainedModelLabel": "{MODEL-NAME}"
}

Klucz	Symbol zastępczy	Wartość	Przykład
trainedModelLabel	`{MODEL-NAME}`	Nazwa modelu, która zostanie przypisana do wdrożenia. Można przypisywać tylko pomyślnie wytrenowane modele. Ta wartość jest uwzględniana w wielkości liter.	`myModel`

Po wysłaniu żądania interfejsu API otrzymasz odpowiedź wskazującą 202 , że zadanie zostało przesłane poprawnie. W nagłówkach odpowiedzi wyodrębnij operation-location wartość. Zostanie on sformatowany w następujący sposób:

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

Element {JOB-ID} służy do identyfikowania żądania, ponieważ ta operacja jest asynchroniczna. Możesz użyć tego adresu URL, aby uzyskać stan wdrożenia.

Pobieranie stanu zadania wdrożenia

Użyj następującego żądania GET , aby wykonać zapytanie dotyczące stanu zadania wdrożenia. Możesz użyć adresu URL otrzymanego z poprzedniego kroku lub zastąpić poniższe wartości symboli zastępczych własnymi wartościami.

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

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{DEPLOYMENT-NAME}`	Nazwa wdrożenia. Ta wartość jest uwzględniana w wielkości liter.	`staging`
`{JOB-ID}`	Identyfikator lokalizowania stanu trenowania modelu. Jest to wartość nagłówka `location` otrzymana w poprzednim kroku.	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx`
`{API-VERSION}`	Wersja wywoływanego interfejsu API. Wartość, do których odwołuje się tutaj, dotyczy najnowszej wersji wydanej. Dowiedz się więcej o innych dostępnych wersjach interfejsu API	`2022-05-01`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść odpowiedzi

Po wysłaniu żądania otrzymasz następującą odpowiedź. Nie sonduj tego punktu końcowego , dopóki parametr stanu nie zmieni się na "powodzenie". Powinien zostać wyświetlony 200 kod wskazujący powodzenie żądania.

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

Zamień wdrożenia

Wdrożenia można zamienić po przetestowaniu modelu przypisanego do jednego wdrożenia i przypisać go do innego. Zamiana wdrożeń obejmuje przypisanie modelu do pierwszego wdrożenia i przypisanie go do drugiego wdrożenia. Następnie pobranie modelu przypisanego do drugiego wdrożenia i przypisanie go do pierwszego wdrożenia. Może to służyć do zamiany production wdrożeń i staging , gdy chcesz użyć modelu przypisanego do staging usługi i przypisania go do productionusługi .

Language Studio
Interfejsy API REST

Aby zamienić wdrożenia z poziomu programu Language Studio

Na stronie Wdrażanie modelu wybierz dwa wdrożenia, które chcesz zamienić, i wybierz pozycję Zamień wdrożenia z górnego menu.
W wyświetlonym oknie wybierz nazwy wdrożeń, które chcesz zamienić.

Utwórz żądanie POST przy użyciu następującego adresu URL, nagłówków i treści JSON, aby rozpocząć zadanie wdrażania zamiany.

Adres URL żądania

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{API-VERSION}`	Wersja wywoływanego interfejsu API. Wartością, do których odwołuje się tutaj, jest najnowsza wersja modelu wydana.	`2022-05-01`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść żądania

{
  "firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
  "secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}

Klucz	Symbol zastępczy	Wartość	Przykład
firstDeploymentName	`{FIRST-DEPLOYMENT-NAME}`	Nazwa pierwszego wdrożenia. Ta wartość jest uwzględniana w wielkości liter.	`production`
secondDeploymentName	`{SECOND-DEPLOYMENT-NAME}`	Nazwa drugiego wdrożenia. Ta wartość jest uwzględniana w wielkości liter.	`staging`

Po wysłaniu żądania interfejsu API otrzymasz odpowiedź wskazującą 202 powodzenie.

Aby usunąć wdrożenie z poziomu programu Language Studio, przejdź do strony Wdrażanie modelu . Wybierz wdrożenie, które chcesz usunąć, a następnie wybierz pozycję Usuń wdrożenie w górnym menu.

Utwórz żądanie DELETE przy użyciu następującego adresu URL, nagłówków i treści JSON, aby usunąć wdrożenie.

Adres URL żądania

{Endpoint}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{deploymentName}?api-version={API-VERSION}

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{DEPLOYMENT-NAME}`	Nazwa wdrożenia. Ta wartość jest uwzględniana w wielkości liter.	`prod`
`{API-VERSION}`	Wersja wywoływanego interfejsu API. Wartość, do których odwołuje się tutaj, dotyczy najnowszej wersji wydanej. Dowiedz się więcej o innych dostępnych wersjach interfejsu API	`2022-05-01`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Po wysłaniu żądania interfejsu API otrzymasz odpowiedź wskazującą 202 powodzenie, co oznacza, że wdrożenie zostało usunięte. Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania.

Przypisywanie zasobów wdrażania

Projekt można wdrożyć w wielu regionach , przypisując różne zasoby językowe, które istnieją w różnych regionach.

Language Studio
Interfejsy API REST

Aby przypisać zasoby wdrażania w innych regionach w programie Language Studio:

Upewnij się, że masz przypisaną rolę właściciela języka usług Cognitive Services do zasobu użytego do utworzenia projektu.
Przejdź do strony Wdrażanie modelu w programie Language Studio.
Wybierz kartę Regiony .
Wybierz pozycję Dodaj zasób wdrożenia.
Wybierz zasób języka w innym regionie.

Teraz możesz przystąpić do wdrażania projektu w regionach, w których przypisano zasoby.

Programowe przypisywanie zasobów wdrażania wymaga uwierzytelniania entra firmy Microsoft. Identyfikator Entra firmy Microsoft służy do potwierdzania, że masz dostęp do zasobów, które chcesz przypisać do projektu na potrzeby wdrożenia w wielu regionach. Aby programowo używać uwierzytelniania firmy Microsoft Entra podczas wykonywania wywołań interfejsu API REST, dowiedz się więcej z dokumentacji usług Azure AI.

Przypisywanie zasobu

Prześlij żądanie POST przy użyciu następującego adresu URL, nagłówków i treści JSON, aby przypisać zasoby wdrożenia.

Adres URL żądania

Podczas tworzenia żądania interfejsu API użyj następującego adresu URL. Zastąp poniższe wartości symboli zastępczych własnymi wartościami.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{API-VERSION}`	Wersja wywoływanego interfejsu API.	`2022-10-01-preview`

Nagłówki

Użyj uwierzytelniania firmy Microsoft Entra, aby uwierzytelnić ten interfejs API.

Treść

Użyj następującego przykładowego kodu JSON jako treści.

{
  "resourcesMetadata": [
    {
      "azureResourceId": "{AZURE-RESOURCE-ID}",
      "customDomain": "{CUSTOM-DOMAIN}",
      "region": "{REGION-CODE}"
    }
  ]
}

Klucz	Symbol zastępczy	Wartość	Przykład
`azureResourceId`	`{AZURE-RESOURCE-ID}`	Pełna ścieżka identyfikatora zasobu, którą chcesz przypisać. Znaleziono w witrynie Azure Portal na karcie Właściwości zasobu w polu Identyfikator zasobu .	`/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource`
`customDomain`	`{CUSTOM-DOMAIN}`	Niestandardowa poddomena zasobu, który chcesz przypisać. Znaleziono w witrynie Azure Portal na karcie Klucze i punkt końcowy zasobu jako pole Punkt końcowy w adresie URL `https://<your-custom-subdomain>.cognitiveservices.azure.com/`	`contosoresource`
`region`	`{REGION-CODE}`	Kod regionu określający region zasobu, który chcesz przypisać. Znaleziono w witrynie Azure Portal na karcie Klucze i punkt końcowy zasobu w polu Lokalizacja/region .	`eastus`

Uzyskiwanie stanu zasobu przypisania

Użyj następującego żądania GET , aby uzyskać stan zadania przypisania zasobu wdrożenia. Zastąp poniższe wartości symboli zastępczych własnymi wartościami.

Adres URL żądania

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

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{JOB-ID}`	Identyfikator zadania służącego do uzyskiwania stanu wdrożenia przypisania. Jest to wartość nagłówka `operation-location` odebrana z interfejsu API w odpowiedzi na żądanie przypisania zasobu wdrożenia.	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx`
`{API-VERSION}`	Wersja wywoływanego interfejsu API.	`2022-10-01-preview`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść odpowiedzi

Po wysłaniu żądania otrzymasz następującą odpowiedź. Nie sonduj tego punktu końcowego status , dopóki parametr nie zmieni się na succeeded.

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

Anulowanie przypisania zasobów wdrażania

Usunięcie lub usunięcie zasobu wdrożenia z projektu spowoduje również usunięcie wszystkich wdrożeń wdrożonych w regionie tego zasobu.

Language Studio
Interfejsy API REST

Aby cofnąć przypisanie lub usunąć zasoby wdrożenia w innych regionach przy użyciu programu Language Studio:

Przejdź do karty Regiony na stronie Wdrażanie modelu.
Wybierz zasób, który chcesz cofnąć przypisania.
Wybierz przycisk Usuń przypisanie.
W wyświetlonym oknie wpisz nazwę zasobu, który chcesz usunąć.

Nieprzypisane zasób

Prześlij żądanie POST przy użyciu następującego adresu URL, nagłówków i treści JSON, aby cofnąć przypisanie lub usunąć zasoby wdrożenia z projektu.

Adres URL żądania

Podczas tworzenia żądania interfejsu API użyj następującego adresu URL. Zastąp poniższe wartości symboli zastępczych własnymi wartościami.

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{API-VERSION}`	Wersja wywoływanego interfejsu API.	`2022-10-01-preview`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść

Użyj następującego przykładowego kodu JSON jako treści.

{
  "assignedResourceIds": [
    "{AZURE-RESOURCE-ID}"
  ]
}

Klucz	Symbol zastępczy	Wartość	Przykład
`assignedResourceIds`	`{AZURE-RESOURCE-ID}`	Pełna ścieżka identyfikatora zasobu, którą chcesz cofnąć. Znaleziono w witrynie Azure Portal na karcie Właściwości zasobu jako pole Identyfikator zasobu.	`/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource`

Pobieranie stanu nieprzypisanych zasobów

Użyj następującego żądania GET , aby uzyskać stan zadania nieprzypisanych zasobów wdrożenia. Zastąp poniższe wartości symboli zastępczych własnymi wartościami.

Adres URL żądania

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

Symbol zastępczy	Wartość	Przykład
`{ENDPOINT}`	Punkt końcowy do uwierzytelniania żądania interfejsu API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{PROJECT-NAME}`	Nazwa projektu. Ta wartość jest uwzględniana w wielkości liter.	`myProject`
`{JOB-ID}`	Identyfikator zadania służącego do uzyskiwania stanu wdrożenia przypisania. Jest to wartość nagłówka `operation-location` odebrana z interfejsu API w odpowiedzi na żądanie nieprzypisywania zasobu wdrożenia.	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx`
`{API-VERSION}`	Wersja wywoływanego interfejsu API.	`2022-10-01-preview`

Nagłówki

Użyj następującego nagłówka, aby uwierzytelnić żądanie.

Key	Wartość
`Ocp-Apim-Subscription-Key`	Klucz do zasobu. Służy do uwierzytelniania żądań interfejsu API.

Treść odpowiedzi

Po wysłaniu żądania otrzymasz następującą odpowiedź. Nie sonduj tego punktu końcowego , dopóki parametr stanu nie zmieni się na "powodzenie".

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

Następne kroki

Używanie interfejsu API przewidywania do wykonywania zapytań względem modelu

Udostępnij za pośrednictwem

Wdrażanie modelu i klasyfikowanie tekstu przy użyciu interfejsu API środowiska uruchomieniowego

Wymagania wstępne

Wdrażanie modelu

Przesyłanie zadania wdrożenia

Nagłówki

Treść żądania

Pobieranie stanu zadania wdrożenia

Nagłówki

Treść odpowiedzi

Zamień wdrożenia

Adres URL żądania

Nagłówki

Treść żądania

Usuwanie wdrożenia

Adres URL żądania

Nagłówki

Przypisywanie zasobów wdrażania

Przypisywanie zasobu

Adres URL żądania

Nagłówki

Treść

Uzyskiwanie stanu zasobu przypisania

Adres URL żądania

Nagłówki

Treść odpowiedzi

Anulowanie przypisania zasobów wdrażania

Nieprzypisane zasób

Adres URL żądania

Nagłówki

Treść

Pobieranie stanu nieprzypisanych zasobów

Adres URL żądania

Nagłówki

Treść odpowiedzi

Następne kroki

Opinia

Dodatkowe zasoby