Skip to content
GOCUX
Documentation
GOCUX / Documentationextract

Control document import inputs

Use explicit file metadata and classification to make imports predictable.

Use explicit file metadata and classification to make imports predictable.

Practical procedure

  1. Keep filename extensions consistent with the bytes you send. A text export and an office document require different extraction capabilities; renaming a file does not convert it.
  2. Supply a title that remains meaningful in a citation and select a retention class recognized by the deployment. Validate base64 before sending a large request.
  3. Inspect tables, headings and unusual characters in the extracted text. When a format loses essential structure, prepare a faithful text export with the source reference preserved.

Import evidence with its provenance

Create a Knowledge source for the selected project before adding documents. The upload endpoint accepts JSON with base64-encoded file bytes, a title, filename, classification and retention choice. GoCux extracts text and stores the text with a checksum; the original uploaded bytes are not the retained Knowledge document. Keep your authorized original separately when your workflow needs it.

Contract example

Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.

POST /knowledge/sources/{source_id}/documents — example request body

{
  "title": "Renewal note",
  "filename": "renewal.txt",
  "contentBase64": "UmVuZXdhbCB0ZXJtczogMzAgZGF5cy4=",
  "dataClassification": "public"
}

Inspect the result

After a successful import, record the document identifier and review the resulting text. Search the project for a known phrase to check that useful content was extracted. Embeddings may be filled later, so immediate verification should include a lexical query. Preserve the source name and extraction context when referring to the document elsewhere.

What to keep explicit

The API body does not expose arbitrary extraction tuning flags from other services. Format support is a deployed capability and must be tested with representative documents.

Handle incomplete and refused work

Invalid base64, an unsupported classification, or extracted text above the configured cap is refused. The request bounds contentBase64 to 40,000,000 characters; this is not a promise that every file of that size or format can be meaningfully extracted. Rich document support depends on deployed extraction capabilities. Missing source and unavailable storage are separate errors.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring