DeepFellow DOCS

Ingest a file's chunks as documents into the knowledge graph

Chunk an uploaded file via the doc-chunker and queue its sections as graph documents.

Without force, acts on the file's latest ingestion job: none yet starts one; completed returns it as is, after retrying the graph removal of any document whose DELETE failed (503 if that fails again); failed/pending resumes it (re-chunking if it has no documents yet); in_progress returns 409, unless it has had no update for graph.ingestion_stale_after_seconds, in which case it is treated as abandoned and resumed. A running job's worker bumps updated_at periodically (see GraphIngestionService._heartbeat), so only a job whose worker is gone (e.g. a server restart) goes stale.

POST
/v1/graph/files/{file_id}/ingest
Authorization[Bearer <token>]

In: header

Path Parameters

file_id[string]

A 24-character hexadecimal MongoDB ObjectId string.

Match^[0-9a-fA-F]{24}$

Query Parameters

force?[boolean]
Defaultfalse

Header Parameters

OpenAI-Organization?[string | null]

Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.

OpenAI-Project?[string | null]

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 POST "https://deepfellow-server-host/v1/graph/files/5eb7cf5a86d9755df3a6c593/ingest?force=false" \  -H "OpenAI-Organization: string" \  -H "OpenAI-Project: string"
{
  "status": "queued",
  "document_count": 0,
  "job_id": "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.