Erstellen von Projekten im Orchestrierungsworkflow

Mit dem Orchestrierungsworkflow können Sie Projekte erstellen, die Ihre Anwendungen mit de folgenden Features verknüpft:

• Benutzerdefiniertes Language Understanding
• Beantworten von Fragen
• LUIS

Voraussetzungen

Bevor Sie mit dem Orchestrierungsworkflow beginnen, benötigen Sie Folgendes:

• Azure-Abonnement – kostenloses Abonnement erstellen.
• Eine Azure KI Language-Ressource

Erstellen einer Sprachressource

Bevor Sie den Orchestrierungsworkflow nutzen können, benötigen Sie eine Azure KI Language-Ressource.

Hinweis

• Ihnen muss die Rolle Besitzer für die Ressourcengruppe zugewiesen sein, damit Sie eine Sprachressource erstellen können.
• Wenn Sie Fragen und Antworten verwenden möchten, müssen Sie Fragen und Antworten bei der Ressourcenerstellung aktivieren.

Erstellen einer neuen Ressource im Azure-Portal

1. Wechseln Sie zum Azure-Portal, um eine neue Azure KI Language-Ressource zu erstellen.

2. Klicken Sie auf Mit Erstellung Ihrer Ressource fortfahren.

3. Erstellen Sie eine Sprachressource mit den folgenden Details:

   Instanzdetails	Erforderlicher Wert
   Region	Eine der unterstützten Regionen.
   Name	Ein Name für Ihre Sprachressource.
   Tarif	Einer der unterstützten Preistarife.

Erstellen einer neuen Sprachressource über Language Studio

Wenn Sie sich zum ersten Mal anmelden, wird in Language Studio ein Fenster angezeigt, in dem Sie eine vorhandene Sprachressource auswählen oder eine neue erstellen können. Sie können eine Ressource auch erstellen, indem Sie auf das Einstellungssymbol in der oberen rechten Ecke klicken, Ressourcen auswählen und dann auf Neue Ressource erstellen klicken.

Erstellen Sie eine Sprachressource mit den folgenden Details:

Instanzdetails	Erforderlicher Wert
Azure-Abonnement	Ihr Azure-Abonnement
Azure-Ressourcengruppe	Ihre Azure-Ressourcengruppe
Name der Azure-Ressource	Ihr Azure-Ressourcenname
Standort	Hier finden Sie weitere Informationen zu unterstützten Regionen.
Tarif	Weitere Informationen zu unterstützten Tarifen finden Sie hier.

Wichtig

• Achten Sie darauf, dass Sie Verwaltete Identität aktivieren, wenn Sie eine Sprachressource erstellen.
• Lesen und Bestätigen des Hinweises zu verantwortungsvoller KI

Anmelden bei Language Studio

Um eine neue Absicht zu erstellen, wählen Sie die Schaltfläche +Hinzufügen aus. Geben Sie Ihrer Absicht nun einen Namen. Es werden zwei Optionen angezeigt, um eine Verbindung mit einem Projekt herzustellen oder nicht. Sie können eine Verbindung zu Projekten (LUIS, Fragenbeantwortung oder Konversationssprache) herstellen oderkeine Option wählen.

Erstellen eines Orchestrierungsworkflow-Projekts

Sobald Sie eine Sprachressource erstellt haben, erstellen Sie ein Orchestrierungsworkflow-Projekt.

Language Studio

1. Suchen Sie in Language Studio den Abschnitt Understand questions and conversational language (Fragen und Unterhaltungssprache verstehen), und wählen Sie Orchestrierungsworkflow aus.

   

2. Dadurch gelangen Sie zur Seite Orchestrierungsworkflow-Projekt. Wählen Sie Neues Projekt erstellen aus. Zum Erstellen eines Projekts müssen Sie die folgenden Detailinformationen angeben:

Wert	Beschreibung
Name	Einen Namen für Ihr Projekt.
BESCHREIBUNG	Eine optionale Projektbeschreibung.
Utterances primary language (Primäre Sprache für Äußerungen)	Die primäre Sprache Ihres Projekts. Ihre Trainingsdaten sollten hauptsächlich in dieser Sprache vorliegen.

Wenn Sie fertig sind, wählen Sie Weiter aus, und überprüfen Sie die Details. Wählen Sie Projekt erstellen aus, um den Prozess abzuschließen. Nun sollte der Bildschirm Schemaerstellung in Ihrem Projekt angezeigt werden.

REST-APIs

Übermitteln Sie eine PATCH-Anforderung mithilfe der folgenden URL, der Header und des JSON-Texts, um ein neues Projekt zu erstellen.

Anfrage-URL

Verwenden Sie zum Erstellen Ihrer API-Anforderung die folgende URL. Ersetzen Sie die folgenden Platzhalter durch Ihre eigenen Werte.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Platzhalter	Wert	Beispiel
{ENDPOINT}	Der Endpunkt für die Authentifizierung Ihrer API-Anforderung.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	myProject
{API-VERSION}	Dies ist die Version der von Ihnen aufgerufenen API.	2023-04-01

Header

Verwenden Sie den folgenden Header, um Ihre Anforderung zu authentifizieren.

Schlüssel	Wert
Ocp-Apim-Subscription-Key	Der Schlüssel für Ihre Ressource. Wird für die Authentifizierung Ihrer API-Anforderungen verwendet.

Body

Verwenden Sie den folgenden JSON-Beispieltext.

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Orchestration",
  "description": "Project description"
 }

Schlüssel	Platzhalter	Wert	Beispiel
projectName	{PROJECT-NAME}	Der Name des Projekts. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	EmailApp
language	{LANGUAGE-CODE}	Hierbei handelt es sich um eine Zeichenfolge, die den Sprachcode für die in Ihrem Projekt verwendete Äußerung angibt. Wählen Sie bei einem mehrsprachigen Projekt den Sprachcode aus, der für die Mehrheit der Äußerungen verwendet wird.	en-us

Importieren eines Orchestrierungsworkflow-Projekts

Language Studio

Sie können ein Orchestrierungsworkflow-Projekt jederzeit als JSON-Datei exportieren, indem Sie die Seite Orchestrierungsworkflow-Projekte aufrufen, ein Projekt auswählen und im oberen Menü auf Exportieren klicken.

Dieses Projekt kann als neues Projekt erneut importiert werden. Wenn Sie ein Projekt mit genau demselben Namen importieren, werden die Daten des Projekts durch die Daten des neu importierten Projekts ersetzt.

Um ein Projekt zu importieren, wählen Sie die Pfeilschaltfläche neben Neues Projekt erstellen und anschließend Importieren aus, und wählen Sie dann die JSON-Datei aus.

REST-APIs

Sie können einen Orchestrierungsworkflow JSON in den Dienst importieren

Übermitteln Sie eine POST-Anforderung mithilfe der folgenden URL, der Header und des JSON-Texts, um Ihr Projekt zu importieren.

Anfrage-URL

Verwenden Sie zum Erstellen Ihrer API-Anforderung die folgende URL. Ersetzen Sie die folgenden Platzhalter durch Ihre eigenen Werte.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}

Platzhalter	Wert	Beispiel
{ENDPOINT}	Der Endpunkt für die Authentifizierung Ihrer API-Anforderung.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	myProject
{API-VERSION}	Dies ist die Version der von Ihnen aufgerufenen API.	2023-04-01

Header

Verwenden Sie den folgenden Header, um Ihre Anforderung zu authentifizieren.

Schlüssel	Wert
Ocp-Apim-Subscription-Key	Der Schlüssel für Ihre Ressource. Wird für die Authentifizierung Ihrer API-Anforderungen verwendet.

Body

Hinweis

Bei jeder Absicht sollte es sich nur um einen einzelnen Typ handeln (CLU, LUIS und Fragen und Antworten).

Verwenden Sie den folgenden JSON-Beispieltext.

{
  "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": "00000000-0000-0000-0000-000000000000",
            "appVersion": "string",
            "slotName": "string"
          },
          "cluOrchestration": {
            "projectName": "string",
            "deploymentName": "string"
          },
          "qnaOrchestration": {
            "projectName": "string"
          }
        }
      }
    ],
    "utterances": [
      {
        "text": "Trying orchestration",
        "language": "{LANGUAGE-CODE}",
        "intent": "string"
      }
    ]
  }
}

Schlüssel	Platzhalter	Wert	Beispiel
api-version	{API-VERSION}	Die Version der von Ihnen aufgerufenen API. Die hier verwendete Version muss mit der API-Version in der URL identisch sein.	2022-03-01-preview
projectName	{PROJECT-NAME}	Der Name des Projekts. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	EmailApp
language	{LANGUAGE-CODE}	Hierbei handelt es sich um eine Zeichenfolge, die den Sprachcode für die in Ihrem Projekt verwendete Äußerung angibt. Wählen Sie bei einem mehrsprachigen Projekt den Sprachcode aus, der für die Mehrheit der Äußerungen verwendet wird.	en-us

Exportiert ein Projekt

Language Studio

Sie können ein Orchestrierungsworkflow-Projekt jederzeit als JSON-Datei exportieren, indem Sie die Seite Orchestrierungsworkflow-Projekte aufrufen, ein Projekt auswählen und auf Exportieren klicken.

REST-APIs

Sie können ein Orchestrierungsworkflow-Projekt jederzeit als JSON-Datei exportieren.

Erstellen Sie eine POST-Anforderung mithilfe der folgenden URL, der Header und des JSON-Texts, um Ihr Projekt zu exportieren.

Anfrage-URL

Verwenden Sie zum Erstellen Ihrer API-Anforderung die folgende URL. Ersetzen Sie die folgenden Platzhalter durch Ihre eigenen Werte.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:export?stringIndexType=Utf16CodeUnit&api-version={API-VERSION}

Platzhalter	Wert	Beispiel
{ENDPOINT}	Der Endpunkt für die Authentifizierung Ihrer API-Anforderung.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	EmailApp
{API-VERSION}	Dies ist die Version der von Ihnen aufgerufenen API.	2023-04-01

Header

Verwenden Sie den folgenden Header, um Ihre Anforderung zu authentifizieren.

Schlüssel	Wert
Ocp-Apim-Subscription-Key	Der Schlüssel für Ihre Ressource. Wird für die Authentifizierung Ihrer API-Anforderungen verwendet.

Nachdem Sie Ihre API-Anforderung gesendet haben, erhalten Sie eine 202-Antwort, die angibt, dass sie erfolgreich war. Extrahieren Sie in den Antwortheadern den operation-location-Wert. Er weist das folgende Format auf:

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

JOB-ID wird verwendet, um Ihre Anforderung zu identifizieren, da es sich um einen asynchronen Vorgang handelt. Verwenden Sie diese URL, um den exportierten JSON-Projektcode mit derselben Authentifizierungsmethode abzurufen.

Details zum Orchestrierungsprojekt abrufen

Language Studio

1. Navigieren Sie in Language Studio zur Seite mit den Projekteinstellungen.

2. Sie können Projektdetails anzeigen.

3. Auf dieser Seite können Sie die Projektbeschreibung aktualisieren.

4. Außerdem können Sie auf dieser Seite den Primärschlüssel der Ressource abrufen.

   

REST-APIs

Um die Details eines Orchestrierungsworkflow-Projekts abzurufen, senden Sie eine GET-Anforderung unter Verwendung der folgenden URL und Header. Ersetzen Sie die Platzhalterwerte durch eigene Werte.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Platzhalter	Wert	Beispiel
{ENDPOINT}	Der Endpunkt für die Authentifizierung Ihrer API-Anforderung.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	myProject
{API-VERSION}	Dies ist die Version der von Ihnen aufgerufenen API.	2023-04-01

Header

Verwenden Sie den folgenden Header, um Ihre Anforderung zu authentifizieren.

Schlüssel	Wert
Ocp-Apim-Subscription-Key	Der Schlüssel für Ihre Ressource. Wird für die Authentifizierung Ihrer API-Anforderungen verwendet.

Antworttext

Nachdem Sie die Anforderung gesendet haben, erhalten Sie die folgende Antwort.

{
  "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}"
}

Nachdem Sie Ihre API-Anforderung gesendet haben, erhalten Sie eine Antwort vom Typ 200, die angibt, dass die Anforderung erfolgreich war, sowie den JSON-Antworttext mit Ihren Projektdetails.

Löschen eines Projekts

Language Studio

Wenn Sie Ihr Projekt nicht mehr benötigen, können Sie das Projekt mithilfe von Language Studio löschen. Wählen Sie im linken Navigationsmenü Projekte und das zu löschende Projekt aus und dann im oberen Menü Löschen.

REST-APIs

Wenn Sie Ihr Projekt nicht mehr benötigen, können Sie das Projekt mithilfe von APIs löschen.

Erstellen Sie mithilfe der folgenden URL, der Header und des JSON-Texts eine LÖSCH-Anforderung, um mit dem Löschen eines CLU-Projekts zu beginnen.

Anfrage-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Platzhalter	Wert	Beispiel
{ENDPOINT}	Der Endpunkt für die Authentifizierung Ihrer API-Anforderung.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet.	myProject
{API-VERSION}	Dies ist die Version der von Ihnen aufgerufenen API.	2023-04-01

Header

Verwenden Sie den folgenden Header, um Ihre Anforderung zu authentifizieren.

Schlüssel	Wert
Ocp-Apim-Subscription-Key	Der Schlüssel für Ihre Ressource. Wird für die Authentifizierung Ihrer API-Anforderungen verwendet.

Nachdem Sie Ihre API-Anforderung gesendet haben, erhalten Sie eine Antwort vom Typ 202, die anzeigt, dass Ihr Projekt erfolgreich gelöscht wurde.

Nächste Schritte

Schemaerstellung