Update document

PATCH

https://{your_space_name}.signalwire.com/api/datasphere/documents/:id

PATCH

/api/datasphere/documents/:id

$ curl -X PATCH https://{your_space_name}.signalwire.com/api/datasphere/documents/id \
>      -H "Content-Type: application/json" \
>      -u "<project_id>:<api_token>" \
>      -d '{
>   "tags": [
>     "sports",
>     "football",
>     "game"
>   ]
> }'

1 {
2   "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3   "filename": "player_list.pdf",
4   "status": "in_progress",
5   "tags": [
6     "sports",
7     "football",
8     "game"
9   ],
10   "chunking_strategy": "sentence",
11   "max_sentences_per_chunk": 80,
12   "split_newlines": true,
13   "overlap_size": 10,
14   "chunk_size": 50,
15   "number_of_chunks": 2345,
16   "chunks_uri": "/api/rest/datasphere/documents/acaa5c49-be5e-4477-bce0-48f4b23b7720/chunks",
17   "created_at": "2024-05-06T12:20-12Z",
18   "updated_at": "2024-05-06T12:20-12Z"
19 }

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.

Learn more about API scopes.

Changes the tags used to organize a Datasphere document and constrain knowledge retrieval. This operation does not replace the source URL or reconfigure chunking. Search document content through [Search documents](/docs/apis/rest/documents/search-documents). #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _DataSphere_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Document.

Request

This endpoint expects an object.

tagslist of stringsRequired

Document tags.

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the Document.

filenamestring

Name of the Document.

statusenum

Status of the Document.

tagslist of strings

Document tags.

chunking_strategyenum

Strategy used to chunk the document.

max_sentences_per_chunkinteger or null

Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.

split_newlinesboolean or null

Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.

overlap_sizeinteger or null

Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.

chunk_sizeinteger or null

Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.

number_of_chunksinteger

Number of Chunks in the Document.

chunks_uristring

URI path to the chunks for this document.

created_atdatetime

Document Creation Date.

updated_atdatetime

Document Update Date.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error