Retrieve text from file
Return the text or Markdown of the specified file.
The file is converted on first use and the converted document is kept, so later calls - and any
ingestion into a vector store - reuse it instead of converting again. Because of this,
image_mode=descriptions only causes descriptions to be generated on a file's first-ever call:
a later call requesting descriptions on an already-converted file gets no descriptions if the
first call didn't ask for them either.
In: header
Path Parameters
The ID of the file to use for this request.
^[0-9a-fA-F]{24}$Query Parameters
How images are represented in the output.
"none""none" | "descriptions" | "embedded" | "referenced"Output format: plain text or Markdown.
"txt""txt" | "md"Header Parameters
Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.
Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization
Response Body
curl -X GET "https://deepfellow-server-host/v1/files/5eb7cf5a86d9755df3a6c593/text?image_mode=none&output_format=txt" \ -H "OpenAI-Organization: string" \ -H "OpenAI-Project: string""string"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.