how to get access to quote in file search annotation

there is no quote in the library under "FileCitation"

class FileCitation(BaseModel):
    file_id: str
    """The ID of the specific File the citation is from."""


class FileCitationAnnotation(BaseModel):
    end_index: int

    file_citation: FileCitation

    start_index: int

    text: str
    """The text in the message content that needs to be replaced."""

    type: Literal["file_citation"]
    """Always `file_citation`."""

Hi Marj De

Greetings & Welcome to the Microsoft Q&A forum! Thank you for sharing your query.

To access the quote in file search annotations using Python, you can utilize the File Citation Annotation class that you have defined. This class includes properties such as file citation, which contains the file-id, and the text property that represents the citation text.

To retrieve the quote, you would typically need to implement a method to fetch the file content using the file-id from the File Citation object.

• Use the file-id from the File Citation to locate the file.
• Implement a function that retrieves the content of the file associated with the file-id.
• Extract the specific quote from the file content based on the indices provided in the File Citation Annotation.
• Unfortunately, without specific methods or APIs outlined in the context for retrieving file content based on file-id. can you refer this https://zcusa.951200.xyz/en-us/azure/ai-services/openai/how-to/assistant#message-annotations I hope this helps you! Thankyou!

The code snippet I shared is from the OpenAI library, and I’m pointing out that it doesn't include the "quote" attribute . My question is how to retrieve the text that appears when I hover over the citations in the Playground, as shown in the picture below:

Running the code you provided, I’m encountering the following error:

AttributeError: 'FileCitation' object has no attribute 'quote'

Hi Marj De

Assuming your completion object contains a structure with a message that includes text, here's how you could retrieve it:

completion = {

"choices": [

    {

        "message": {

            "context": {

                "text": "This is the text you want to retrieve.",

                "citations": [

                    {"URL": "http://example.com/article1", "file path": "article1.pdf"},

                    {"URL": "http://example.com/article2", "file path": "article2.pdf"}

                ]

            }

        }

    }

]
}

# Retrieve the text from the completion object

text = completion["choices"][0] ["message"] ["context"] ["text"]

# Print the retrieved text

print ("Retrieved Text:")

print(text)

# Optionally, print citations as well

citations = completion["choices"][0] ["message"] ["context"] ["citations"]

print("\citations:")

for citation in citations:

yaml
print (citation: {citation['URL']} - Source: {citation ['file path']")

I hope this helps you! Thank you!

Hi Marj De

following up to see if the above response was helpful.