How to pass custom fields from AI Search index to OpenAI chat completions citation object?

Joshua Brumpton 0

When calling the chat completion through the python SDK:

completion = await client.chat.completions.create(...)

I use an Azure AI Search index as a data source. The fields mapping available strictly cover only this set:
https://learn.microsoft.com/en-us/azure/ai-services/openai/references/azure-search?tabs=python#fields-mapping-options

However, I want the ability to retrieve custom fields without having to assign them to a FieldMappingOptions value. I have the "filepath" option mapped to the chunk filepath in blob storage. I also have a "source_filepath" which maps the source document filepath in blob storage. So ideally I would be able to add the following custom field mapping:

"source_filepath": "source_filepath"

And then I can use that from the response by the Azure OpenAI service in the citation object.

Avinash Devarakonda 340 Reputation points Microsoft Vendor

2024-12-03T07:14:33.3333333+00:00

Hi Joshua Brumpton,

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

To pass custom fields from an AI Search index to the OpenAI chat completions citation object, you need to ensure that your data is ingested into the Azure AI Search index. This involves uploading files using either Azure OpenAI Studio or the ingestion API, where your data will be chunked and embedded into the Azure AI Search instance. While the default field mapping options are limited, you can still map custom fields by specifying them directly in your request. For example, you can map the source_filepath field by including it in the fieldMappings parameter of your request. Once the custom fields are mapped, you can retrieve them from the response by accessing the model_extra attribute in the completion object. Kindly try from your end and let us know if you face any issues.

Using your data with Azure OpenAI Service - Azure OpenAI | Microsoft Learn

Thank You.
Avinash Devarakonda 340 Reputation points Microsoft Vendor

2024-12-04T06:27:13.49+00:00

Hi Joshua Brumpton,

Following up to see if the given response was helpful.

Thank you.

Share via

How to pass custom fields from AI Search index to OpenAI chat completions citation object?

Your answer