Queue Document Analysis
queue_document_analysisQueue a background NLP analysis of a document for readability, entities, and sentiment, returning a job ID immediately. Use for large documents to avoid blocking; poll progress with get_job_status.
Instructions
Enqueue a background NLP analysis of one document (readability, entities, sentiment) and return a job id immediately without blocking. Poll the job with get_job_status and stop it with cancel_job. Use this for large documents where a synchronous analyze_document call would be slow; use analyze_document directly for quick, inline results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | Document body as plain text. May be empty. | |
| options | No | Optional flags selecting which analyses to run and the job priority. | |
| documentId | Yes | Scrivener document UUID, as returned by get_structure (a binder item "id"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | Identifier of the queued job; poll it with get_job_status. |