Quickstart: Indelingswerkstroom

  • Artikel

Gebruik dit artikel om aan de slag te gaan met Orchestration-werkstroomprojecten met behulp van Language Studio en de REST API. Volg deze stappen om een voorbeeld uit te proberen.

Vereisten

Aanmelden bij Language Studio

  1. Ga naar Language Studio en meld u aan met uw Azure-account.

  2. Zoek in het venster Kies een taalresource dat wordt weergegeven uw Azure-abonnement en kies uw Taalresource. Als u geen resource hebt, kunt u een nieuwe maken.

    Exemplaardetails Vereiste waarde
    Azure-abonnement Uw Azure-abonnement.
    Azure-resourcegroep Uw Azure-resourcegroep.
    Azure-resourcenaam De naam van uw Azure-resource.
    Locatie Een geldige locatie voor uw Azure-resource. Bijvoorbeeld 'VS - west 2'.
    Prijscategorie Een ondersteunde prijscategorie voor uw Azure-resource. U kunt de laag Gratis (F0) gebruiken om de service uit te proberen.

    Een schermopname van het scherm voor het selecteren van resources in Language Studio.

Een indelingswerkstroomproject maken

Zodra u een taalresource hebt gemaakt, maakt u een indelingswerkstroomproject. Een project is een werkgebied voor het bouwen van uw aangepaste ML-modellen op basis van uw gegevens. Uw project kan alleen worden geopend door u en anderen die toegang hebben tot de taalresource die wordt gebruikt.

Voor deze quickstart voltooit u de quickstart conversational language understanding om een conversatieproject voor taalkennis te maken dat later wordt gebruikt.

  1. Zoek in Language Studio de sectie Informatie over vragen en gesprekstaal en selecteer Indelingswerkstroom.

    Een schermopname van de locatie van de indelingswerkstroomsectie op de landingspagina van Language Studio.

  2. Hiermee gaat u naar de projectpagina Van de Indelingswerkstroom . Selecteer Nieuw project maken. Als u een project wilt maken, moet u de volgende details opgeven:

Waarde Beschrijving
Naam Een naam voor uw project.
Beschrijving Optionele projectbeschrijving.
Primaire taal van utterances De primaire taal van uw project. Uw trainingsgegevens moeten voornamelijk in deze taal zijn.

Wanneer u klaar bent, selecteert u Volgende en bekijkt u de details. Selecteer Project maken om het proces te voltooien. U ziet nu het scherm Schema bouwen in uw project.

Schema bouwen

Nadat u de quickstart voor het begrijpen van de gesprekstaal hebt voltooid en een indelingsproject hebt gemaakt, is de volgende stap het toevoegen van intenties.

Verbinding maken met het eerder gemaakte conversational language understanding-project:

  • Selecteer op de pagina Schema bouwen in uw indelingsproject de optie Toevoegen om een intentie toe te voegen.
  • Geef in het venster dat wordt weergegeven een naam op voor uw intentie.
  • Selecteer Ja, ik wil het koppelen aan een bestaand project.
  • Selecteer in de vervolgkeuzelijst verbonden services de optie Gespreks Language Understanding.
  • Selecteer in de vervolgkeuzelijst projectnaam het project voor het begrijpen van de gesprekstaal.
  • Selecteer Intentie toevoegen om uw intentie te maken.

Uw model trainen

Als u een model wilt trainen, moet u een trainingstaak starten. De uitvoer van een geslaagde trainingstaak is uw getrainde model.

Ga als volgende te werk om uw model te trainen vanuit Language Studio:

  1. Selecteer Trainingstaken in het menu aan de linkerkant.

  2. Selecteer Een trainingstaak starten in het bovenste menu.

  3. Selecteer Een nieuw model trainen en typ de naam van het model in het tekstvak. U kunt een bestaand model ook overschrijven door deze optie te selecteren en het model te kiezen dat u wilt overschrijven in de vervolgkeuzelijst. Het overschrijven van een getraind model kan niet ongedaan worden gemaakt, maar dit heeft geen invloed op uw geïmplementeerde modellen totdat u het nieuwe model implementeert.

    Als u uw project hebt ingeschakeld om uw gegevens handmatig te splitsen bij het taggen van uw uitingen, ziet u twee opties voor het splitsen van gegevens:

    • De testset automatisch splitsen van trainingsgegevens: uw getagde uitingen worden willekeurig verdeeld tussen de trainings- en testsets, op basis van de percentages die u kiest. De standaardpercentagesplitsing is 80% voor training en 20% voor testen. Als u deze waarden wilt wijzigen, kiest u welke set u wilt wijzigen en typt u de nieuwe waarde.

    Notitie

    Als u de optie De testset automatisch splitsen van trainingsgegevens kiest, worden alleen de uitingen in uw trainingsset gesplitst volgens de opgegeven percentages.

    • Een handmatige splitsing van training- en testgegevens gebruiken: wijs elke uiting toe aan de trainings- of testset tijdens de taggingstap van het project.

    Notitie

    Het gebruik van een handmatige splitsing van training- en testgegevens wordt alleen ingeschakeld als u uitingen toevoegt aan de testset op de pagina met taggegevens. Anders wordt deze uitgeschakeld.

    Een schermopname van de pagina Model trainen voor projecten voor het begrijpen van gesprekstalen.

  4. Selecteer de knop Trainen .

Notitie

  • Alleen voltooide trainingstaken genereren modellen.
  • Training kan enkele minuten tot enkele uren duren, afhankelijk van de grootte van uw getagde gegevens.
  • U kunt slechts één trainingstaak tegelijk uitvoeren. U kunt geen andere trainingstaak starten met hetzelfde project totdat de actieve taak is voltooid.

Uw model implementeren

Over het algemeen controleert u na het trainen van een model de evaluatiedetails. In deze quickstart implementeert u alleen uw model en maakt u het beschikbaar voor u om het uit te proberen in Language Studio, of u kunt de voorspellings-API aanroepen.

Uw model implementeren vanuit Language Studio:

  1. Selecteer Een model implementeren in het menu aan de linkerkant.

  2. Selecteer Implementatie toevoegen om een nieuwe implementatietaak te starten.

    Een schermopname van de knop voor modelimplementatie in Language Studio.

  3. Selecteer Nieuwe implementatie maken om een nieuwe implementatie te maken en een getraind model toe te wijzen in de vervolgkeuzelijst hieronder. U kunt ook een bestaande implementatie overschrijven door deze optie te selecteren en het getrainde model te selecteren dat u eraan wilt toewijzen in de vervolgkeuzelijst hieronder.

    Notitie

    Het overschrijven van een bestaande implementatie vereist geen wijzigingen in uw voorspellings-API-aanroep , maar de resultaten die u krijgt, zijn gebaseerd op het zojuist toegewezen model.

    Een schermopname van het scherm voor het toevoegen van een nieuwe implementatie in Language Studio.

  4. Als u een of meer LUIS-toepassingen of conversatietaalverstaanprojecten verbindt, moet u de implementatienaam opgeven.

    • Er zijn geen configuraties vereist voor aangepaste vragen beantwoorden of niet-gekoppelde intenties.

    • LUIS-projecten moeten worden gepubliceerd naar de site die is geconfigureerd tijdens de orchestration-implementatie en aangepaste vraagantwoord-KB's moeten ook worden gepubliceerd naar hun productiesites.

  5. Selecteer Implementeren om uw implementatietaak te verzenden

  6. Nadat de implementatie is voltooid, wordt er een vervaldatum naast weergegeven. Het verlopen van de implementatie is wanneer uw geïmplementeerde model niet beschikbaar is om te worden gebruikt voor voorspellingen. Dit gebeurt meestal twaalf maanden nadat een trainingsconfiguratie is verlopen.

Testmodel

Nadat uw model is geïmplementeerd, kunt u het gaan gebruiken om voorspellingen te doen via de voorspellings-API. Voor deze quickstart gebruikt u Language Studio om een utterance in te dienen, voorspellingen op te halen en de resultaten te visualiseren.

Uw model testen vanuit Language Studio

  1. Selecteer Implementaties testen in het menu aan de linkerkant.

  2. Selecteer het model dat u wilt testen. U kunt alleen modellen testen die zijn toegewezen aan implementaties.

  3. Selecteer in de vervolgkeuzelijst implementatienaam de naam van uw implementatie.

  4. Voer in het tekstvak een uiting in die u wilt testen.

  5. Selecteer in het bovenste menu de optie De test uitvoeren.

  6. Nadat u de test hebt uitgevoerd, ziet u het antwoord van het model in het resultaat. U kunt de resultaten bekijken in de weergave entiteitskaarten of in JSON-indeling.

    Een schermopname van het testen van een model in Language Studio.

Resources opschonen

Wanneer u uw project niet meer nodig hebt, kunt u het project verwijderen met behulp van Language Studio. Selecteer Projecten in het linkernavigatiemenu, selecteer het project dat u wilt verwijderen en selecteer vervolgens Verwijderen in het bovenste menu.

Vereisten

Een taalresource maken op basis van Azure Portal

Een nieuwe resource maken op basis van de Azure Portal

  1. Ga naar de Azure Portal om een nieuwe Azure AI Language-resource te maken.

  2. Selecteer Doorgaan om uw resource te maken

  3. Maak een taalresource met de volgende details.

    Exemplaardetails Vereiste waarde
    Region Een van de ondersteunde regio's.
    Naam Een naam voor uw taalresource.
    Prijscategorie Een van de ondersteunde prijscategorieën.

Uw resourcesleutels en eindpunt ophalen

  1. Ga naar de overzichtspagina van uw resource in de Azure Portal.

  2. Selecteer sleutels en eindpunt in het menu aan de linkerkant. U gebruikt het eindpunt en de sleutel voor de API-aanvragen

    Een schermopname van de sleutel- en eindpuntpagina in de Azure Portal

Een indelingswerkstroomproject maken

Zodra u een taalresource hebt gemaakt, maakt u een indelingswerkstroomproject. Een project is een werkgebied voor het bouwen van uw aangepaste ML-modellen op basis van uw gegevens. Uw project kan alleen worden geopend door u en anderen die toegang hebben tot de taalresource die wordt gebruikt.

Voltooi voor deze quickstart de CLU-quickstart om een CLU-project te maken dat moet worden gebruikt in de indelingswerkstroom.

Dien een PATCH-aanvraag in met behulp van de volgende URL, headers en JSON-hoofdtekst om een nieuw project te maken.

Aanvraag-URL

Gebruik de volgende URL bij het maken van uw API-aanvraag. Vervang de waarden van de tijdelijke aanduidingen hieronder door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst

Gebruik de volgende voorbeeld-JSON als uw lichaam.

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Orchestration",
  "description": "Project description"
 }
Sleutel Tijdelijke aanduiding Waarde Voorbeeld
projectName {PROJECT-NAME} De naam van uw project. Deze waarde is hoofdlettergevoelig. EmailApp
language {LANGUAGE-CODE} Een tekenreeks die de taalcode aangeeft voor de uitingen die in uw project worden gebruikt. Als uw project een meertalig project is, kiest u de taalcode van de meeste uitingen. en-us

Schema bouwen

Na het voltooien van de CLU-quickstart en het maken van een indelingsproject, bestaat de volgende stap uit het toevoegen van intenties.

Dien een POST-aanvraag in met behulp van de volgende URL, headers en JSON-hoofdtekst om uw project te importeren.

Aanvraag-URL

Gebruik de volgende URL bij het maken van uw API-aanvraag. Vervang de waarden van de tijdelijke aanduidingen hieronder door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst

Notitie

Elke intentie mag slechts van één type zijn van (CLU, LUIS en qna)

Gebruik de volgende voorbeeld-JSON als uw lichaam.

{
  "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"
      }
    ]
  }
}
Sleutel Tijdelijke aanduiding Waarde Voorbeeld
api-version {API-VERSION} De versie van de API die u aanroept. De versie die hier wordt gebruikt, moet dezelfde API-versie in de URL zijn. 2022-03-01-preview
projectName {PROJECT-NAME} De naam van uw project. Deze waarde is hoofdlettergevoelig. EmailApp
language {LANGUAGE-CODE} Een tekenreeks die de taalcode aangeeft voor de uitingen die in uw project worden gebruikt. Als uw project een meertalig project is, kiest u de taalcode van de meeste uitingen. en-us

Uw model trainen

Als u een model wilt trainen, moet u een trainingstaak starten. De uitvoer van een geslaagde trainingstaak is uw getrainde model.

Maak een POST-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om een trainingstaak in te dienen.

Aanvraag-URL

Gebruik de volgende URL bij het maken van uw API-aanvraag. Vervang de waarden van de tijdelijke aanduidingen hieronder door uw eigen waarden.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:train?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. EmailApp
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Aanvraagbody

Gebruik het volgende object in uw aanvraag. Het model krijgt een naam MyModel zodra de training is voltooid.

{
  "modelLabel": "{MODEL-NAME}",
  "trainingMode": "standard",
  "trainingConfigVersion": "{CONFIG-VERSION}",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}
Sleutel Tijdelijke aanduiding Waarde Voorbeeld
modelLabel {MODEL-NAME} Uw modelnaam. Model1
trainingMode standard Trainingsmodus. Er is slechts één modus voor training beschikbaar in indeling, namelijk standard. standard
trainingConfigVersion {CONFIG-VERSION} De versie van het trainingsconfiguratiemodel. Standaard wordt de nieuwste modelversie gebruikt. 2022-05-01
kind percentage Splitsmethoden. Mogelijke waarden zijn percentage en manual. Zie Een model trainen voor meer informatie. percentage
trainingSplitPercentage 80 Percentage van uw getagde gegevens dat moet worden opgenomen in de trainingsset. De aanbevolen waarde is 80. 80
testingSplitPercentage 20 Percentage van uw getagde gegevens dat moet worden opgenomen in de testset. De aanbevolen waarde is 20. 20

Notitie

De trainingSplitPercentage en testingSplitPercentage zijn alleen vereist als Kind is ingesteld op percentage en de som van beide percentages gelijk moet zijn aan 100.

Zodra u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat het is gelukt. Extraheer de waarde in de operation-location antwoordheaders. De indeling wordt als volgt weergegeven:

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

U kunt deze URL gebruiken om de status van de trainingstaak op te halen.

Trainingsstatus ophalen

Training kan tussen de 10 en 30 minuten duren. U kunt de volgende aanvraag gebruiken om de status van de trainingstaak te blijven peilen totdat deze is voltooid.

Gebruik de volgende GET-aanvraag om de status van de trainingsvoortgang van uw model op te halen. Vervang de waarden van de tijdelijke aanduidingen hieronder door uw eigen waarden.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{YOUR-ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. EmailApp
{JOB-ID} De id voor het zoeken naar de trainingsstatus van uw model. Dit is in de location headerwaarde die u hebt ontvangen bij het indienen van uw trainingstaak. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst van antwoord

Nadat u de aanvraag hebt verzonden, krijgt u het volgende antwoord. Blijf dit eindpunt pollen totdat de statusparameter verandert in 'geslaagd'.

{
  "result": {
    "modelLabel": "{MODEL-LABEL}",
    "trainingConfigVersion": "{TRAINING-CONFIG-VERSION}",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "xxxxxx-xxxxx-xxxxxx-xxxxxx",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}
Sleutel Waarde Voorbeeld
modelLabel De modelnaam Model1
trainingConfigVersion De configuratieversie van de training. Standaard wordt de nieuwste versie gebruikt. 2022-05-01
startDateTime De tijd waarop de training is gestart 2022-04-14T10:23:04.2598544Z
status De status van de trainingstaak running
estimatedEndDateTime Geschatte tijd voor het voltooien van de trainingstaak 2022-04-14T10:29:38.2598544Z
jobId Uw trainingstaak-id xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
createdDateTime Aanmaakdatum en -tijd van trainingstaak 2022-04-14T10:22:42Z
lastUpdatedDateTime Datum en tijd van de trainingstaak voor het laatst bijgewerkt 2022-04-14T10:23:45Z
expirationDateTime Vervaldatum en -tijd van trainingstaak 2022-04-14T10:22:42Z

Uw model implementeren

Over het algemeen bekijkt u na het trainen van een model de evaluatiedetails. In deze quickstart implementeert u gewoon uw model en roept u de voorspellings-API aan om een query uit te voeren op de resultaten.

Implementatietaak verzenden

Maak een PUT-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om te beginnen met het implementeren van een indelingswerkstroommodel.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{DEPLOYMENT-NAME} De naam voor uw implementatie. Deze waarde is hoofdlettergevoelig. staging
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Aanvraagbody

{
  "trainedModelLabel": "{MODEL-NAME}",
}
Sleutel Tijdelijke aanduiding Waarde Voorbeeld
trainedModelLabel {MODEL-NAME} De modelnaam die aan uw implementatie wordt toegewezen. U kunt alleen goed getrainde modellen toewijzen. Deze waarde is hoofdlettergevoelig. myModel

Zodra u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat het is gelukt. Extraheer de waarde in de operation-location antwoordheaders. De indeling wordt als volgt weergegeven:

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

U kunt deze URL gebruiken om de status van de implementatietaak op te halen.

Status van implementatietaak ophalen

Gebruik de volgende GET-aanvraag om de status van uw implementatietaak op te halen. Vervang de waarden van de tijdelijke aanduidingen hieronder door uw eigen waarden.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{DEPLOYMENT-NAME} De naam voor uw implementatie. Deze waarde is hoofdlettergevoelig. staging
{JOB-ID} De id voor het zoeken naar de trainingsstatus van uw model. Dit bevindt zich in de location headerwaarde die u van de API hebt ontvangen als reactie op uw aanvraag voor modelimplementatie. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Hoofdtekst van antwoord

Nadat u de aanvraag hebt verzonden, krijgt u het volgende antwoord. Blijf dit eindpunt pollen totdat de statusparameter verandert in 'geslaagd'.

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

Querymodel

Nadat uw model is geïmplementeerd, kunt u het gaan gebruiken om voorspellingen te doen via de voorspellings-API.

Zodra de implementatie is voltooid, kunt u beginnen met het uitvoeren van query's op uw geïmplementeerde model voor voorspellingen.

Maak een POST-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om te beginnen met het testen van een indelingswerkstroommodel.

Aanvraag-URL

{ENDPOINT}/language/:analyze-conversations?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Aanvraagbody

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Text1",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "{PROJECT-NAME}",
    "deploymentName": "{DEPLOYMENT-NAME}",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

Hoofdtekst van antwoord

Nadat u de aanvraag hebt verzonden, krijgt u het volgende antwoord voor de voorspelling.

{
  "kind": "ConversationResult",
  "result": {
    "query": "App Service overview",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://learn.microsoft.com/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

Resources opschonen

Wanneer u uw project niet meer nodig hebt, kunt u het project verwijderen met behulp van de API's.

Maak een DELETE-aanvraag met behulp van de volgende URL, headers en JSON-hoofdtekst om een project voor gesprekstaal te verwijderen.

Aanvraag-URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}
Tijdelijke aanduiding Waarde Voorbeeld
{ENDPOINT} Het eindpunt voor het verifiëren van uw API-aanvraag. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} De naam voor uw project. Deze waarde is hoofdlettergevoelig. myProject
{API-VERSION} De versie van de API die u aanroept. 2023-04-01

Kopteksten

Gebruik de volgende header om uw aanvraag te verifiëren.

Sleutel Waarde
Ocp-Apim-Subscription-Key De sleutel voor uw resource. Wordt gebruikt voor het verifiëren van uw API-aanvragen.

Nadat u uw API-aanvraag hebt verzonden, ontvangt u een 202 antwoord dat aangeeft dat het is gelukt. Dit betekent dat uw project is verwijderd.

Volgende stappen