How to specify Search API Version in a Chatbot API request?

Question

Hello!

We have an application that:

• Implements a Chatbot through Open AI service. The chatbot requests are being handled through a REST API request.
• We have an index created in Azure Cognitive Search, which is implementing Vector Search, using large-3-embedding model for the vectorization of our data. Our index was created using the 2023-11-01 API Version.
• The chatbot is looking on the above index to retrieve information. We specify in the API request: The model used for embeddings, and the embedding endpoint and api key as well The endpoint and key to access the search service The index name, and semantic configuration to be used

What we are noting in the logs from our Azure Search service, is that the request being made by the chatbot is using the 2023-07-01-Preview version of the API to perform the search request.

My question is, how can I specify the API version for the search used by the chatbot?

I was looking at this https://github.com/Azure/azure-rest-api-specs/blob/1f6e89637068d59b5ae935de9a88d5742d12f8e6/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/inference.json#L1136 without finding anything around that specific parameter

Answer 1

Welcome to Microsoft Q&A Forum, Thank you for posting your query here!

• Confirmed Understanding: You have an application that integrates a chatbot powered by OpenAI with Azure Cognitive Search. The chatbot interacts with an index in Azure Cognitive Search, which was created using the 2023-11-01 API version. However, it appears that the chatbot is using the 2023-07-01-Preview API version instead.
• Answer: It seems there might be some confusion regarding the versioning of Azure Search and Azure OpenAI. Here’s a clearer explanation:

1. Azure Search Version: When you create an index in Azure Search, you specify an API version, in this case, 2023-11-01. This version is used throughout the lifecycle of the index, including any queries made to it. Therefore, any interaction with this index, regardless of the client (in this case, the OpenAI chatbot), will use the 2023-11-01 version.
2. Azure OpenAI Version: Azure OpenAI uses its own versioning system independent of Azure Search. In your case, it seems to be using the 2023-07-01-Preview version. This version pertains to the features and capabilities of the OpenAI service itself, not the Azure Search service. You can check the available versions and update to the latest one if necessary by referring to the official Azure OpenAI documentation. (https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#embeddings)

I hope this provides a clearer understanding of the versioning systems of Azure Search and Azure OpenAI, and how they interact in your application.

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.