Query deployment to extract entities

After the deployment is added successfully, you can query the deployment to extract entities from your text based on the model you assigned to the deployment. You can query the deployment programmatically using the Prediction API or through the Client libraries (Azure SDK).

Test deployed model

You can use Language Studio to submit the custom entity recognition task and visualize the results.

To test your deployed models from within the Language Studio:

  1. Select Testing deployments from the left side menu.

  2. Select the deployment you want to test. You can only test models that are assigned to deployments.

  3. For multilingual projects, from the language dropdown, select the language of the text you are testing.

  4. Select the deployment you want to query/test from the dropdown.

  5. You can enter the text you want to submit to the request or upload a .txt file to use.

  6. Click on Run the test from the top menu.

  7. In the Result tab, you can see the extracted entities from your text and their types. You can also view the JSON response under the JSON tab.

    View the test results

Send an entity recognition request to your model

  1. After the deployment job is completed successfully, select the deployment you want to use and from the top menu click on Get prediction URL.

    A screenshot showing the button to get a prediction URL.

  2. In the window that appears, under the Submit pivot, copy the sample request URL and body into your command line.

  3. Replace <YOUR_DOCUMENT_HERE> with the actual text you want to extract entities from.

    A screenshot showing the example request.

  4. Submit the POST cURL request in your terminal or command prompt. You'll receive a 202 response with the API results if the request was successful.

  5. In the response header you receive extract {JOB-ID} from operation-location, which has the format: {ENDPOINT}/text/analytics/v3.2-preview.2/analyze/jobs/<JOB-ID}>

  6. Back to Language Studio; select Retrieve pivot from the same window you got the example request you got earlier and copy the sample request into a text editor.

    A screenshot showing the example retrieval request.

  7. Replace <JOB-ID> with the {JOB-ID} you extracted from the previous step.

  8. Submit the GET cURL request in your terminal or command prompt.

Next steps