Upload my own data using Rest API

Baraa Ali-ElSafty 0

I need to upload my own data (Upload files) to Azure OpenAI using Rest APIs not using Azure OpenAI studio portal.

1 answer

dupammi 8,535 Reputation points Microsoft Vendor

2024-07-24T11:29:59.5866667+00:00

Hi @Baraa Ali-ElSafty

Thank you for your question.

You can upload your own data to Azure OpenAI using the REST API. Here’s a brief overview of the process:

Prepare Your Data: Ensure your data is accessible and structured according to the requirements of Azure OpenAI. This might involve storing your data in Azure Blob Storage, Azure Cognitive Search, or another compatible service.

Authentication: Use the keys and endpoint provided for your deployment to authenticate your API requests.

You can then access Azure OpenAI on your data using a REST API or the web-based interface in the Azure OpenAI Studio. Make sure that you have correctly loaded your data into the deployment. You can check this by verifying that your data is visible in the Chat Playground or Web App.

Please refer to the Azure OpenAI Service REST API reference documentation for details on how to structure a request and receive a response.

I hope this helps. Thank you.

Please don't forget to click Accept Answer and Yes for was this answer helpful.
Please sign in to rate this answer.
Baraa Ali-ElSafty 0 Reputation points

2024-07-24T11:39:37.1833333+00:00

I know I can access Azure OpenAI on my data using a REST API, but my question is how to upload my files using REST API? not using Azure OpenAI Studio.

dupammi 8,535 Reputation points Microsoft Vendor

2024-07-24T12:21:54.2433333+00:00

Hi @Baraa Ali-ElSafty

Thank you for your follow-up question.

There is no API available for directly uploading data into the Azure OpenAI deployment playground. The deployment playground is intended for deploying and testing models through a user interface, rather than serving as a data storage or management system.

You can use the Azure OpenAI Service API to create and manage models, which can subsequently be deployed to the deployment playground. The API allows you to upload your data to Azure Cognitive Search or other data storage services, and then create a model that references this data.

After creating a model, you can deploy it to the deployment playground using the Azure OpenAI Service API or the Azure portal. The deployment playground offers a user interface for testing and interacting with your deployed model.

Unfortunately, the best and currently available method to add your data preview feature is through Azure OpenAI Studio. For more information, please refer to this documentation:

https://learn.microsoft.com/en-us/azure/ai-services/openai/use-your-data-quickstart?tabs=command-line&pivots=rest-api#add-your-data-using-azure-openai-studio

We don't have any additional information to share with you at this time.

I hope this clarifies your query.

If possible, could you retake the survey? Your feedback is valuable and helps us improve.

Thank you.

Baraa Ali-ElSafty 0 Reputation points

2024-07-24T22:30:52.4666667+00:00

Hi @dupammi ,

Thanks for your feedback.

My understanding is when we upload files using Azure OpenAI Studio, they are reflected in both the Azure Blob Storage resource and the Azure AI Search resource.

Additionally, we are specifying the index name when calling the Azure OpenAI API to get the answer from our documents.

I found an API to upload files to a specific index name according to this documentation: Azure Search Service API.

Could you please let me know if this approach is sufficient?

Thank you for your assistance.

dupammi 8,535 Reputation points Microsoft Vendor

2024-07-25T03:15:32.6666667+00:00

Hi @Baraa Ali-ElSafty

Thank you for your detailed response and for sharing your findings.

Yes, your approach using the Azure AI Search REST API to upload files directly to a specific index is indeed a viable method. By uploading your data to Azure Cognitive Search, you can then reference this index when calling the Azure OpenAI API to retrieve answers from your documents.

Here are some useful links from the Azure documentation to help you :

Azure AI Search REST API documentation

Creating and managing indexes

Uploading documents

By following these steps, you can successfully upload and manage your data using the REST API and this approach should meet your requirements effectively.

Please don't forget to click Accept Answer and Yes for was this answer helpful. This would help other members of the community searching for similar solutions.

YutongTie-MSFT 52,866 Reputation points

2024-07-29T08:20:58.48+00:00

Hi @Baraa Ali-ElSafty

Thanks for reaching out to us again, do you have a chance to check on above answer? Does it solve your issue? Please let us know if you need any other information.

Please kindly accept the answer if you feel helpful to support the community, thanks a lot.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Upload my own data using Rest API

1 answer

Your answer