Not
Åtkomst till denna sida kräver auktorisation. Du kan prova att logga in eller byta katalog.
Åtkomst till denna sida kräver auktorisation. Du kan prova att byta katalog.
Med arbetsflödet för orkestrering kan du skapa projekt som ansluter dina program till:
- Anpassad språkförståelse (CLU)
- Frågesvar
- LUIS
Förutsättningar
Innan du börjar använda orkestreringsarbetsflödet behöver du flera saker:
- En Azure-prenumeration – Skapa en kostnadsfritt.
- En Azure Language in Foundry Tools-resurs
Skapa en språkresurs
Innan du börjar använda arbetsflödet för orkestrering behöver du en Språkresurs.
Kommentar
- Du måste ha en ägarroll tilldelad till resursgruppen för att skapa en språkresurs.
- Om du planerar att använda frågesvar måste du aktivera frågesvar vid skapande av resurser
Skapa en ny resurs från Azure Portal
Gå till Azure-portalen för att skapa en ny Azure Language in Foundry Tools-resurs.
Välj Fortsätt för att skapa resursen
Skapa en språkresurs med följande information.
Instansinformation Obligatoriskt värde Region En av de regioner som stöds. Name Ett namn på språkresursen. Prisnivå En av de prisnivåer som stöds.
Skapa ett arbetsflödesprojekt för orkestrering (REST API)
När du har skapat en språkresurs skapar du ett arbetsflödesprojekt för orkestrering.
Skicka en PATCH-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att skapa ett nytt projekt.
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}?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 |
Rubriker
Använd följande rubrik för att autentisera din begäran.
| Nyckel | 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.
{
"projectName": "{PROJECT-NAME}",
"language": "{LANGUAGE-CODE}",
"projectKind": "Orchestration",
"description": "Project description"
}
| Nyckel | Platshållare | Värde | Exempel |
|---|---|---|---|
projectName |
{PROJECT-NAME} |
Namnet på projektet. Det här värdet är skiftlägeskänsligt. | EmailApp |
language |
{LANGUAGE-CODE} |
En sträng som anger språkkoden för de yttranden som används i projektet. Om projektet är ett flerspråkigt projekt väljer du språkkoden för de flesta yttrandena. | en-us |
Importera ett arbetsflödesprojekt för orkestrering (REST API)
Du kan importera ett JSON-orkestreringsarbetsflöde till tjänsten
Skicka en POST-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att importera 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}/:import?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 |
Rubriker
Använd följande rubrik för att autentisera din begäran.
| Nyckel | Värde |
|---|---|
Ocp-Apim-Subscription-Key |
Nyckeln till resursen. Används för att autentisera dina API-begäranden. |
Brödtext
Kommentar
Varje avsikt bör endast vara av en typ från (CLU, LUIS och qna)
Använd följande JSON-exempel som brödtext.
{
"projectFileVersion": "{API-VERSION}",
"stringIndexType": "Utf16CodeUnit",
"metadata": {
"projectKind": "Orchestration",
"settings": {
"confidenceThreshold": 0
},
"projectName": "{PROJECT-NAME}",
"description": "Project description",
"language": "{LANGUAGE-CODE}"
},
"assets": {
"projectKind": "Orchestration",
"intents": [
{
"category": "string",
"orchestration": {
"kind": "luis",
"luisOrchestration": {
"appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
"appVersion": "string",
"slotName": "string"
},
"cluOrchestration": {
"projectName": "string",
"deploymentName": "string"
},
"qnaOrchestration": {
"projectName": "string"
}
}
}
],
"utterances": [
{
"text": "Trying orchestration",
"language": "{LANGUAGE-CODE}",
"intent": "string"
}
]
}
}
| Nyckel | Platshållare | Värde | Exempel |
|---|---|---|---|
api-version |
{API-VERSION} |
Den version av API:et som du anropar. Den version som används här måste vara samma API-version i URL:en. | 2022-03-01-preview |
projectName |
{PROJECT-NAME} |
Namnet på projektet. Det här värdet är skiftlägeskänsligt. | EmailApp |
language |
{LANGUAGE-CODE} |
En sträng som anger språkkoden för de yttranden som används i projektet. Om projektet är ett flerspråkigt projekt väljer du språkkoden för de flesta yttrandena. | en-us |
Exportera projektdata (REST API)
Du kan exportera ett arbetsflödesprojekt för orkestrering som en JSON-fil när som helst.
Skapa en POST-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att exportera 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}/:export?stringIndexType=Utf16CodeUnit&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. | EmailApp |
{API-VERSION} |
Den version av API:et som du anropar. | 2023-04-01 |
Rubriker
Använd följande rubrik för att autentisera din begäran.
| Nyckel | 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. I svarshuvudena extraherar du värdet operation-location formaterat så här:
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-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. Använd den här URL:en för att hämta det exporterade projektets JSON med samma autentiseringsmetod.
Hämta information om orkestreringsprojekt (REST API)
Om du vill få information om ett orkestreringsarbetsflödesprojekt skickar du en GET-begäran med hjälp av följande URL och rubriker. Ersätt platshållarvärdena med dina egna värden.
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-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 |
{API-VERSION} |
Den version av API:et som du anropar. | 2023-04-01 |
Rubriker
Använd följande rubrik för att autentisera din begäran.
| Nyckel | Värde |
|---|---|
Ocp-Apim-Subscription-Key |
Nyckeln till resursen. Används för att autentisera dina API-begäranden. |
Svarskropp
När du har skickat begäran får du följande svar.
{
"createdDateTime": "2022-04-18T13:53:03Z",
"lastModifiedDateTime": "2022-04-18T13:53:03Z",
"lastTrainedDateTime": "2022-04-18T14:14:28Z",
"lastDeployedDateTime": "2022-04-18T14:49:01Z",
"projectKind": "Orchestration",
"projectName": "{PROJECT-NAME}",
"description": "This is a sample orchestration project.",
"language": "{LANGUAGE-CODE}"
}
När du har skickat din API-begäran får du ett 200 svar som anger att det lyckades och en JSON-svarsstruktur med dina projektuppgifter.
Ta bort projekt (REST API)
När du inte längre behöver projektet kan du ta bort projektet med hjälp av API:erna.
Skapa en DELETE-begäran med hjälp av följande URL, rubriker och JSON-brödtext för att ta bort ett projekt för förståelse av konversationsspråk.
Begärans-URL
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-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 |
{API-VERSION} |
Den version av API:et som du anropar. | 2023-04-01 |
Rubriker
Använd följande rubrik för att autentisera din begäran.
| Nyckel | 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 projektet har slutförts, vilket innebär att projektet tas bort.