Skip to main content

Files

warning

Draft Specification: functionality has not been implemented yet.

Files can be used by threads, assistants and fine-tuning

Equivalent to: https://platform.openai.com/docs/api-reference/files

Files Object​

{
  // Public properties (OpenAI Compatible: https://platform.openai.com/docs/api-reference/files/object)
  "id": "file-BK7bzQj3FfZFXr7DbL6xJwfo",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "salesOverview.pdf",
  "purpose": "assistants"
}

File API​

List Files​

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/list

Upload file​

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/create

Delete file​

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/delete

Retrieve file​

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve

Retrieve file content​

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve-contents

Files Filesystem​

  • Files can exist in several parts of Jan's filesystem
  • TODO: are files hard copied into these folders? Or do we define a files.json and only record the relative filepath?
/files                  # root `/files` for finetuning, etc
/assistants
    /jan
        /files          # assistant-specific files
/threads
    /jan-12938912
        /files          # thread-specific files