Update a Document with Text

POST

https://api-platform.digitpulse.ai/v1/datasets/{dataset_id}/documents/{document_id}/update-by-text

Last modified:2025-01-13 09:13:34

This API is based on an existing knowledge and updates the document through text based on this knowledge.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "name": "name",
    "text": "text"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-platform.digitpulse.ai/v1/datasets//documents//update-by-text' \
--header 'Authorization: ' \
--header 'X-Timestamp: 1739933362' \
--header 'X-Signature: 1739933362' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "name",
    "text": "text"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "document": {
        "id": "",
        "position": 1,
        "data_source_type": "upload_file",
        "data_source_info": {
            "upload_file_id": ""
        },
        "dataset_process_rule_id": "",
        "name": "name.txt",
        "created_from": "api",
        "created_by": "",
        "created_at": 1695308667,
        "tokens": 0,
        "indexing_status": "waiting",
        "error": null,
        "enabled": true,
        "disabled_at": null,
        "disabled_by": null,
        "archived": false,
        "display_status": "queuing",
        "word_count": 0,
        "hit_count": 0,
        "doc_form": "text_model"
    },
    "batch": ""
}

Modified at 2025-01-13 09:13:34

Delete a Knowledge Base

Update a Document with a File