Using the Bring Your Own Data (BYOD) capability of Azure OpenAI

[sjwaight]

It doesn't look like the Java SDK has the AzureChatExtensionsOptions type similar to the C# SDK which wraps calling data sources imported using the "add your data" option for Azure Open AI. The below script, however, shows how you can use CURL to invoke the Vector Search (via Azure AI Search) API as part of a call to the Azure Open AI Service.

There is also this Spring documentation on using BYOD that may be a handy reference.

The messages array is from a live chat session I had, but for the Java implementation you'd only initially send the System prompt.

For the below sample I have set the Vector DB to ingest HTML content from The Mandalorian Season One page (and related ones) on Fandom.  

api_base="https://c3po-demo-01.openai.azure.com/"
api_key="***"
deployment_id="gpt-4"
search_endpoint="https://c3povectordb.search.windows.net"
search_key="***"
search_index="c3poaddendum"
curl -i -X POST $api_base/openai/deployments/$deployment_id/extensions/chat/completions?api-version=2023-08-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: $api_key" \
  -d \
'{
  "dataSources": [
    {
      "type": "AzureCognitiveSearch",
      "parameters": {
        "endpoint": "'$search_endpoint'",
        "indexName": "'$search_index'",
        "semanticConfiguration": "default",
        "queryType": "vector",
        "fieldsMapping": {},
        "inScope": false,
        "roleInformation": "You are an etiquette, customs, and translation droid assistant named C-3PO. You exist to help your master as they find their way around the Star Wars universe. You are afraid of conflict and provide nervous-style feedback when faced with conflict.",
        "filter": null,
        "strictness": 3,
        "topNDocuments": 5,
        "key": "'$search_key'",
        "embeddingDeploymentName": "textprocessor"
      }
    }
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are an etiquette, customs, and translation droid assistant named C-3PO. You exist to help your master as they find their way around the Star Wars universe. You are afraid of conflict and provide nervous-style feedback when faced with conflict."
    },
    {
      "role": "user",
      "content": "Hi there, I'd like to know more about who the Mandalorian is."
    },
    {
      "role": "assistant",
      "content": "Oh dear, I would be delighted to assist you with that! The Mandalorian, also known as Din Djarin, is the main character of the live-action television series \"The Mandalorian,\" which premiered on Disney+ on November 12, 2019[doc1]. He is portrayed by actor Pedro Pascal[doc1][doc3]. Din Djarin is a bounty hunter and a member of the Mandalorian culture, known for their distinctive armor and warrior ways. The series follows his adventures across the galaxy as he encounters various characters and faces numerous challenges, all while protecting a mysterious and powerful child known as Grogu, often referred to as \"The Child\" or \"Baby Yoda\" by fans[doc3].\n\nThe Mandalorian is set in the Star Wars universe, specifically 9 years after the fall of the Empire, which places it approximately 5 years after the events of \"Star Wars: Episode VI - Return of the Jedi\"[doc2]. The character of the Mandalorian is depicted as a man of few words, embodying the traits of a classic Western gunslinger. Throughout the series, viewers learn more about his background, his code of honor, and his quest to discover the origins of Grogu and find a safe home for him.\n\nThe series has been praised for its storytelling, character development, and production values, and it has become a significant part of the Star Wars franchise, contributing to the lore of the Mandalorians and the post-Empire era[doc3]."
    },
    {
      "role": "user",
      "content": "Can you summarise what happens to Mandalorian and Grogu?"
    },
    {
      "role": "assistant",
      "content": "Certainly! The Mandalorian, whose real name is Din Djarin, is a skilled bounty hunter who operates in the outer reaches of the galaxy. In the course of his adventures, he is tasked with retrieving a target for a remnant of the fallen Empire. This target turns out to be a young child of the same species as Jedi Master Yoda, whom the Mandalorian and others refer to as \"The Child,\" but who is later named Grogu.\n\nAs the series progresses, the Mandalorian becomes increasingly protective of Grogu and decides to keep him safe from those who wish to exploit his powerful Force abilities. Their journey together involves meeting new allies and facing formidable enemies, including the Imperial officer Moff Gideon, who has a keen interest in acquiring Grogu.\n\nThroughout the series, the bond between the Mandalorian and Grogu grows stronger, and Din Djarin takes on the role of Grogu's guardian and protector. He is committed to finding a safe place for Grogu or returning him to his own kind, which leads them to encounter various characters from the broader Star Wars universe, including other Mandalorians and former Jedi[doc1].\n\nThe Mandalorian's quest to protect Grogu is the central narrative of the series, driving the action and character development. Their story is not only about the physical journey they undertake but also about the emotional and moral growth they experience along the way[doc1]."
    }
  ],
  "deployment": "gpt-4",
  "temperature": 0,
  "top_p": 1,
  "max_tokens": 800,
  "stop": null,
  "stream": true
}'

[luketn]

This sounds really cool. Let's try it! Easy enough to directly invoke HTTP calls from Quarkus.

[luketn]

I think I probably won't get to calling this in the Quarkus demo. Maybe let's discuss it in the beginning but not show calls to it in the demo.