knowledge

The methods of pd.knowledge. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.knowledge.list(input, init?)

List a project's knowledge sources

GET /api/workspaces/{workspaceId}/projects/{projectId}/knowledge

Requires knowledge.read on the project; an unknown project answers 404. Returns the sources newest first, each with its ingestion status and the number of stored passages (chunkCount). Passages reach article generation only where the server's rag feature flag is on.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.knowledge.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  projectId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.knowledge.create(input, init?)

Register a knowledge source

POST /api/workspaces/{workspaceId}/projects/{projectId}/knowledge

Requires knowledge.create on the project; an unknown project answers 404. Answers 201 with the source at status pending. With sourceUrl, the address is checked against private ranges (400 if refused) and ingestion is queued at once. Without it, nothing runs until the file is sent with PUT /api/workspaces/{workspaceId}/knowledge/{sourceId}/content. A successful ingestion costs 1 credit (reserved when the run starts, released if it fails; a workspace without the credit gets a failed source). Records a knowledge.added audit entry.

Input

Returns 201 Created

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.knowledge.create({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  projectId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    type: "pdf",
    name: "example",
  },
});
console.log(result);

pd.knowledge.uploadContent(input, init?)

Upload a knowledge source's bytes

PUT /api/workspaces/{workspaceId}/knowledge/{sourceId}/content

The body is the raw file, sent with its own content type (PDF, DOCX, text or markdown). The filename is not kept. Requires knowledge.create. Accepted content types: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain and text/markdown, and the type must match the source's type (pdf, docx, txt, markdown); anything else, or an empty body, answers 400. The limit is 10 MiB (10485760 bytes); a larger body answers 413. A source of type url, web_page or article has no file to upload and answers 400. The source goes back to pending and ingestion is queued. The run is keyed on the source and the file's byte length: a file of the same size uploaded while the earlier run is still on record (about a day after it completes, a week after it fails) is stored but not ingested, and the source stays pending until POST /api/workspaces/{workspaceId}/knowledge/{sourceId}/reingest. Once the new run completes it replaces the stored passages. Records a knowledge.added audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.knowledge.uploadContent({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  sourceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: new Blob([/* the file's bytes */]),
  contentType: "application/pdf",
});
console.log(result);

pd.knowledge.reingest(input, init?)

Re-run ingestion for a knowledge source

POST /api/workspaces/{workspaceId}/knowledge/{sourceId}/reingest

Requires knowledge.update. Queues a new ingestion run for the source and answers at once with status pending; the run itself is asynchronous and ends at ready or failed. Meant for a source that failed, but the call does not check the current status. A source with neither an uploaded file nor a sourceUrl answers 400, an unknown one 404. A successful run costs 1 credit; a workspace without the credit gets a failed source with the reason in errorMessage.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.knowledge.reingest({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  sourceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.knowledge.delete(input, init?)

Delete a knowledge source

DELETE /api/workspaces/{workspaceId}/knowledge/{sourceId}

Requires knowledge.delete; a source that does not exist or belongs to another workspace answers 404. Removes the source and its stored passages, then the uploaded file from storage. A failure to remove the file does not fail the call. Records a knowledge.deleted audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.knowledge.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  sourceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);