Azure OpenAI Service: How to call Semantic Search using the .NET API

Question

Azure OpenAI Service: How to call Semantic Search using the .NET API

大宮僚馬 70

Calling OpenAI Service from a C# application using Azure.AI.OpenAI v1.0.0-beta.8.

I am using the semantic search option in Add your data (preview), but it is not very accurate and I do not know if I am using it correctly.

Is my API call the right way?

The Cognitive Search index was created from Azure OpenAI Studio with Upload files.

Below is the code for the API call.

ChatCompletionsOptions completionsOptions = new ChatCompletionsOptions();
completionsOptions.Temperature = (float)0.0;
completionsOptions.MaxTokens = 800;
completionsOptions.NucleusSamplingFactor = (float)1.0;
completionsOptions.FrequencyPenalty = 0;
completionsOptions.PresencePenalty = 0;

AzureCognitiveSearchIndexFieldMappingOptions options = new AzureCognitiveSearchIndexFieldMappingOptions();
options.ContentFieldNames.Add("content");
options.FilepathFieldName = "filepath";
options.TitleFieldName = "title";
options.UrlFieldName = "url";

completionsOptions.Messages.Add(new ChatMessage(ChatRole.System, "You are an AI assistant that helps people find information."));
completionsOptions.AzureExtensionsOptions = new AzureChatExtensionsOptions()
{
    Extensions =
        {
            new AzureCognitiveSearchChatExtensionConfiguration()
            {
                SearchEndpoint = new Uri(_searchEndPoint),
                SearchKey = new AzureKeyCredential(_searchKey),
                IndexName = _searchIndex,
                QueryType = AzureCognitiveSearchQueryType.Semantic,
                SemanticConfiguration = "default",
                FieldMappingOptions = options,
            },
        }
};

OpenAIClientOptions clientOptions = new OpenAIClientOptions(OpenAIClientOptions.ServiceVersion.V2023_09_01_Preview);
OpenAIClient client = new OpenAIClient(new Uri(_endPoint), new AzureKeyCredential(_apiKey), clientOptions);

Response<ChatCompletions> response = await client.GetChatCompletionsAsync(_model, completionsOptions);

Also attached is a capture of the index configuration.

fields

semantic configurations

Thank you in advance for your help.

大宮僚馬 70 Reputation points

2023-10-16T08:20:08.8+00:00

As a supplement, we usually perform searches on documents in Japanese, and we understand that when indexing with Upload Files on OpenAI Studio, the analyzer is not in Japanese, so the accuracy is reduced.

What I really want to know is whether the semantic search is performed correctly with this call method.

Accepted answer

0 additional answers

Your answer

大宮僚馬 70 Reputation points

2023-10-16T08:20:08.8+00:00

As a supplement, we usually perform searches on documents in Japanese, and we understand that when indexing with Upload Files on OpenAI Studio, the analyzer is not in Japanese, so the accuracy is reduced.

What I really want to know is whether the semantic search is performed correctly with this call method.

Answer 1

brtrach-MSFT 17,731 Microsoft Employee Moderator

@大宮僚馬 To call the semantic search API, you need to use the OpenAIClient.SearchAsync method instead of OpenAIClient.GetChatCompletionsAsync. Here is an example of how to call the semantic search API using the OpenAIClient:

OpenAIClientOptions clientOptions = new OpenAIClientOptions(OpenAIClientOptions.ServiceVersion.V2023_09_01_Preview);
OpenAIClient client = new OpenAIClient(new Uri(_endPoint), new AzureKeyCredential(_apiKey), clientOptions);

string query = "your search query";
string indexName = "your index name";
string semanticConfiguration = "your semantic configuration name";

SearchOptions searchOptions = new SearchOptions();
searchOptions.QueryType = OpenAIQueryType.Semantic;
searchOptions.SemanticConfiguration = semanticConfiguration;

SearchRequest searchRequest = new SearchRequest(query, indexName, searchOptions);

Response response = await client.SearchAsync(searchRequest);

In this example, you need to replace "your search query", "your index name", and "your semantic configuration name" with the appropriate values for your search.

Regarding your question about the accuracy of the semantic search, it is difficult to determine the accuracy without more information about your data and configuration. However, if you are indexing documents in Japanese and the analyzer is not in Japanese, it is possible that the accuracy of the search results will be reduced. You may want to consider using a Japanese analyzer to improve the accuracy of the search results.

大宮僚馬 70 Reputation points

2023-10-18T00:47:07.5366667+00:00

It is not possible to do what you suggest because OpenAIClient does not have a method called SearchAsync.

I could not find it in the documentation.
https://learn.microsoft.com/ja-jp/dotnet/api/azure.ai.openai.openaiclient?view=azure-dotnet-preview#methods

brtrach-MSFT 17,731 Microsoft Employee Moderator

I apologize for the confusion. You are correct that the OpenAIClient does not have a method called SearchAsync. Instead, you can use the SearchClient class to call the semantic search API. Here is an example of how to call the semantic search API using the SearchClient:

SearchClientOptions clientOptions = new SearchClientOptions();
clientOptions.ServiceVersion = SearchClientOptions.ServiceVersion.V2020_06_30;

Uri endpoint = new Uri("your search endpoint");
AzureKeyCredential credential = new AzureKeyCredential("your search key");
string indexName = "your index name";
string semanticConfiguration = "your semantic configuration name";

SearchClient searchClient = new SearchClient(endpoint, indexName, credential, clientOptions);

SearchOptions searchOptions = new SearchOptions();
searchOptions.QueryType = OpenAIQueryType.Semantic;
searchOptions.SemanticConfiguration = semanticConfiguration;

SearchResults results = await searchClient.SearchAsync("your search query", searchOptions);

In this example, you need to replace "your search endpoint", "your search key", "your index name", "your semantic configuration name", and "your search query" with the appropriate values for your search.

大宮僚馬 70 Reputation points

2023-10-19T00:56:45.48+00:00

So if I use Azure.AI.OpenAI v1.0.0-beta.8 to chat with an Azure OpenAI model using my own data, am I correct that I cannot currently perform semantic searches?

If so, what are the properties related to semantic configuration such as AzureCognitiveSearchChatExtensionConfiguration.SemanticConfiguration for?
brtrach-MSFT 17,731 Reputation points Microsoft Employee Moderator

2023-10-20T21:59:31.6933333+00:00

Yes, you are correct. The Azure.AI.OpenAI v1.0.0-beta.8 client library for .NET allows you to interact with Azure OpenAI resources and provides an idiomatic interface and rich integration with the rest of the Azure SDK ecosystem. It supports creating a completion for text and creating a text embedding for comparisons. However, it does not currently support semantic search capabilities. You can use this library to connect to Azure OpenAI resources or to the non-Azure OpenAI inference endpoint. It’s a great choice for even non-Azure OpenAI development.

The AzureCognitiveSearchChatExtensionConfiguration.SemanticConfiguration property in the Azure.AI.OpenAI namespace is used to provide additional semantic configuration for the query. This property is a string and can be set with the desired configuration.

The AzureCognitiveSearchChatExtensionConfiguration class represents configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat extension. It includes properties like Document Count, Embedding Endpoint, Embedding Key, Field Mapping Options, Index Name, Parameters, Query Type, Search Endpoint, Search Key, Semantic Configuration, and Should Restrict Result Scope.

The semantic configuration is part of the overall configuration of Azure Cognitive Search when used as an Azure OpenAI chat extension. It allows you to customize the behavior of your search queries, potentially improving the relevance of your search results. However, it’s important to note that this does not equate to performing a semantic search in the sense of understanding the meaning or context of your search query. It’s more about fine-tuning the behavior of your search queries within the capabilities of Azure Cognitive Search.
大宮僚馬 70 Reputation points

2023-10-23T01:10:32.11+00:00

I understand.

I see that C# cannot perform semantic search with Azure.AI.OpenAI v1.0.0-beta.8.

Thank you for your response.

Share via

Azure OpenAI Service: How to call Semantic Search using the .NET API

0 additional answers

Your answer