Use API commands to utilize Azure OpenAI Web App chatbot

Question

Use API commands to utilize Azure OpenAI Web App chatbot

VasilisK 71

A web app has been deployed to utilize an Azure OpenAI model with my data. Is it possible to send questions and receive answers via API? Or an entirely different approach is needed?

AshokPeddakotla-MSFT 35,951 Reputation points

2024-02-08T11:05:47.56+00:00

VasilisK Just checking if we are still connected on this discussion? Please let us know if you need further help.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. So that we can close this thread.

Accepted answer

0 additional answers

Your answer

AshokPeddakotla-MSFT 35,951 Reputation points

2024-02-08T11:05:47.56+00:00

VasilisK Just checking if we are still connected on this discussion? Please let us know if you need further help.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. So that we can close this thread.

Answer 1

AshokPeddakotla-MSFT 35,951

VasilisK Greetings!

A web app has been deployed to utilize an Azure OpenAI model with my data. Is it possible to send questions and receive answers via API? Or an entirely different approach is needed?

It is possible to send questions and receive answers via the Azure OpenAI REST API.

The Azure OpenAI service provides a set of REST APIs for interacting with the resources and models you deploy via the Management APIs.

You can use these APIs to send questions and receive answers from your deployed model.

Please check the Azure OpenAI Service REST API reference for more details.

Do let me know if that helps or have any further queries.

VasilisK 71 Reputation points

2024-01-29T14:08:52.9766667+00:00

Hi AshokPeddakotla-MSFT, Checking the reference, helped me generating the desired result.

VasilisK 71

Web app is not required to use AOAI via API. A sample of the POST I am using is following:

curl --location 'https://(AOAI_Endpoint).openai.azure.com/openai/deployments/(Model_Deployed_ie_gpt-4)/extensions/chat/completions?api-version=2023-06-01-preview' \
--header 'role: user' \
--header 'api-key: AOAI_Endpoint_api_key' \
--header 'Content-Type: application/json' \
--data '{
  "messages": [
    {
      "role": "user",
      "content": "Here is the user'\''s question"
    }
  ],
  "temperature": 0,
  "max_tokens": 6000,
  "top_p": 1.0,
  "stop": null,
  "stream": false,
  "dataSources": [
    {
      "type": "AzureCognitiveSearch",
      "parameters": {
        "endpoint": "https://(search_service_endpoint).search.windows.net",
        "key": "search_service_key",
        "indexName": "index_name",
        "fieldsMapping": {
          "titleField": "title",
          "urlField": "url",
          "filepathField": "filepath",
  "contentFields": [
    "content"
  ],
  "contentFieldsSeparator": "\n"
        },
        "inScope": true,
        "topNDocuments": 5,
        "queryType": "semantic",
        "semanticConfiguration": "default",
        "roleInformation": "Your guidance goes here.",
        "filter": null,
        "strictness": 3
      }
    }
  ]
}'

AshokPeddakotla-MSFT 35,951 Reputation points

2024-02-06T03:28:12.69+00:00

VasilisK Glad to hear it was helpful and your query is resolved.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. So that we can close this thread.

Doing so would help other community members with similar issue identify the solution. I highly appreciate your contribution to the community.

Share via

Use API commands to utilize Azure OpenAI Web App chatbot

0 additional answers

Your answer