Create a Document

POST 
/documents

Creates a Datasphere Document

Request

application/json

Body

required

oneOf

Sentence strategy

max_sentences_per_chunkinteger

Maximum number of sentences per chunk.

Default value: 50

Example: 40

chunking_strategystring

Strategy for chunking the document

Possible values: [sentence]

Example: sentence

split_newlinesboolean

Whether to split chunks on new lines.

Default value: false

Default value: false

Example: false

urlurirequired

URL of the document.

Example: https://example.com/document.pdf

tagsstring[]

Document tags.

Example: ["sports","football","game"]

Sliding strategy

chunk_sizeinteger

Number of words per chunk.

Default value: 50

Example: 50

chunking_strategystring

Strategy for chunking the document

Possible values: [sliding]

Example: sliding

overlap_sizeinteger

Amount of overlap between chunks, in number of words.

Default value: 10

Example: 10

urlurirequired

URL of the document.

Example: https://example.com/document.pdf

tagsstring[]

Document tags.

Example: ["sports","football","game"]

Page strategy

chunking_strategystring

Strategy for chunking the document

Possible values: [page]

Example: page

urlurirequired

URL of the document.

Example: https://example.com/document.pdf

tagsstring[]

Document tags.

Example: ["sports","football","game"]

Paragraph strategy

chunking_strategystring

Strategy for chunking the document

Possible values: [paragraph]

Example: paragraph

urlurirequired

URL of the document.

Example: https://example.com/document.pdf

tagsstring[]

Document tags.

Example: ["sports","football","game"]

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

Schema

Schema

iduuidrequired

Unique ID of a Document.

filenamestringrequired
Name of the Document.
Example: player_list.pdf
statusDocumentStatus (string)required

The current Status of the Document.

Possible values: [submitted, in_progress, completed, failed]

tagsstring[]required
Document tags.
Example: ["sports","football","game"]
chunking_strategyChunkingStrategy (string)required

Strategy to use when chunking the document.

Possible values: [sentence, paragraph, page, sliding]

max_sentences_per_chunkstringrequired
Max Sentences per Chunk (only used for chunking type 'sentence')
Example: 80
split_newlinesbooleanrequired
Split on Newlines (only used for chunking type 'sentence')
Example: true
overlap_sizestringrequired
Overlap Size (only used for chunking type 'sliding')
Example: 10
chunk_sizestringrequired
Chunk Size (only used for chunking type 'sliding')
Example: 50
number_of_chunksintegerrequired
Number of Chunks in the Document.
Example: 2345
created_atdate-timerequired
Document Creation Date.
Example: 2024-05-06T12:20-12Z
updated_atdate-timerequired
Document Update Date.
Example: 2024-05-06T12:20-12Z

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filename": "player_list.pdf",
  "status": "submitted",
  "tags": [
    "sports",
    "football",
    "game"
  ],
  "chunking_strategy": "sentence",
  "max_sentences_per_chunk": "80",
  "split_newlines": true,
  "overlap_size": "10",
  "chunk_size": "50",
  "number_of_chunks": 2345,
  "created_at": "2024-05-06T12:20-12Z",
  "updated_at": "2024-05-06T12:20-12Z"
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

typestringrequired

Error type.

codestringrequired

Error code.

messagestringrequired

Error details.

attributestringrequired

Request parameter associated with this error.

urlstringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "invalid_parameter",
      "message": "Invalid chunking_strategy",
      "attribute": "chunking_strategy",
      "url": "https://developer.signalwire.com/rest/overview/error-codes#{code}"
    }
  ]
}