AzureExtensionsContext is not populated with document info when called via the API

Question

AzureExtensionsContext is not populated with document info when called via the API

Sean Walsh 50

When I use Azure Data Studio, I can interact with my custom data set and the query returns the AzureExtensionsContext object populated with the appropriate document identification details, as a "tool" role message.

Screenshot of the chat:

User's image

If I inspect that content, I can see the filePath being correctly populated with the file Id (a Guid + PageNumber):

User's image

I copy the C# code into my app, and run it. I get the following:

User's image

I can see the Content populated in the AzureExtensionsContext, but when I inspect that JSON, the filePath is null:

User's image

How do I get the API call to include the file information?

brtrach-MSFT 17,656 Microsoft Employee

@Sean Walsh It seems like you are facing an issue with the AzureExtensionsContext object not being populated with the file information when calling it via the API. This could be due to a few reasons, such as incorrect configuration or missing parameters.

To ensure that the AzureExtensionsContext object is populated with the file information, you need to make sure that you are passing the correct parameters when calling the API. Specifically, you need to pass the fileId and pageNumber parameters to the API call.

Here is an example of how to call the API with the correct parameters:

var client = new SearchClient(new Uri(endpoint), indexName, new AzureKeyCredential(apiKey));
var searchText = "your search query";
var options = new SearchOptions
{
    IncludeTotalCount = true,
    IncludeResults = true,
    QueryType = QueryType.Full
};

// Set the fileId and pageNumber parameters
var parameters = new Dictionary<string, string>
{
    { "fileId", "your file Id" },
    { "pageNumber", "your page number" }
};

// Call the API with the parameters
var response = client.Search<YourIndexModel>(searchText, options, parameters);

// Check if the AzureExtensionsContext object is populated with the file information
if (response.Results.Count > 0)
{
    var result = response.Results[0];
    var azureExtensionsContext = result.Document["@azureSearchExtensions"];
    var filePath = azureExtensionsContext["filePath"];
    // Check if the filePath is populated with the file information
    if (filePath != null)
    {

Sean Walsh 50 Reputation points

2023-10-16T06:06:12.22+00:00

Hi @brtrach-MSFT

Your example seems to be using the Azure.Search.Documents.SearchClient class? The issue I'm having is with the OpenAIClient class, calling the GetChatCompletionsAsync method. I don't think I have the ability to set the fileId and pageNumber parameters. The best I have is to set the AzureExtensionsOptions.Extensions parameter to a AzureChatExtensionConfiguration instance, and set the FieldMappingOptions property therein.

I'm not familiar with the SearchClient class but it seems you're using it to filter the file and page number. What I'm doing is requesting a Chat Completion with an Azure Cognitive Search extension, expecting to be given the file names (filePath's) that were used in the extensions (citations). So I think this is an issue with the AzureCognitiveSearchChatExtensionConfiguration class.
Sean Walsh 50 Reputation points

2023-10-18T14:50:41.13+00:00

This seems to work:

https://github.com/Azure/azure-sdk-for-net/issues/38749#issuecomment-1768633425

Your answer

brtrach-MSFT 17,656 Reputation points Microsoft Employee

2023-10-16T00:46:05.5633333+00:00

@Sean Walsh It seems like you are facing an issue with the AzureExtensionsContext object not being populated with the file information when calling it via the API. This could be due to a few reasons, such as incorrect configuration or missing parameters.

To ensure that the AzureExtensionsContext object is populated with the file information, you need to make sure that you are passing the correct parameters when calling the API. Specifically, you need to pass the fileId and pageNumber parameters to the API call.

Here is an example of how to call the API with the correct parameters:

var client = new SearchClient(new Uri(endpoint), indexName, new AzureKeyCredential(apiKey)); var searchText = "your search query"; var options = new SearchOptions { IncludeTotalCount = true, IncludeResults = true, QueryType = QueryType.Full }; // Set the fileId and pageNumber parameters var parameters = new Dictionary<string, string> { { "fileId", "your file Id" }, { "pageNumber", "your page number" } }; // Call the API with the parameters var response = client.Search<YourIndexModel>(searchText, options, parameters); // Check if the AzureExtensionsContext object is populated with the file information if (response.Results.Count > 0) { var result = response.Results[0]; var azureExtensionsContext = result.Document["@azureSearchExtensions"]; var filePath = azureExtensionsContext["filePath"]; // Check if the filePath is populated with the file information if (filePath != null) {
Sean Walsh 50 Reputation points

2023-10-16T06:06:12.22+00:00

Hi @brtrach-MSFT

Your example seems to be using the Azure.Search.Documents.SearchClient class? The issue I'm having is with the OpenAIClient class, calling the GetChatCompletionsAsync method. I don't think I have the ability to set the fileId and pageNumber parameters. The best I have is to set the AzureExtensionsOptions.Extensions parameter to a AzureChatExtensionConfiguration instance, and set the FieldMappingOptions property therein.

I'm not familiar with the SearchClient class but it seems you're using it to filter the file and page number. What I'm doing is requesting a Chat Completion with an Azure Cognitive Search extension, expecting to be given the file names (filePath's) that were used in the extensions (citations). So I think this is an issue with the AzureCognitiveSearchChatExtensionConfiguration class.
Sean Walsh 50 Reputation points

2023-10-18T14:50:41.13+00:00

This seems to work:

https://github.com/Azure/azure-sdk-for-net/issues/38749#issuecomment-1768633425

Share via

AzureExtensionsContext is not populated with document info when called via the API

Your answer