Retrieve Chunks from a Knowledge Base

POST

https://api-platform.digitpulse.ai/v1/datasets/{dataset_id}/retrieve

Last modified:2025-01-13 09:31:33

Request

Path Params

Header Params

Body Params application/json

Example

{
    "query": "test",
    "retrieval_model": {
        "search_method": "keyword_search",
        "reranking_enable": false,
        "reranking_mode": null,
        "reranking_model": {
            "reranking_provider_name": "",
            "reranking_model_name": ""
        },
        "weights": null,
        "top_k": 1,
        "score_threshold_enabled": false,
        "score_threshold": null
    }
}

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//retrieve' \
--header 'Authorization: ' \
--header 'X-Timestamp: 1739933362' \
--header 'X-Signature: 1739933362' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "test",
    "retrieval_model": {
        "search_method": "keyword_search",
        "reranking_enable": false,
        "reranking_mode": null,
        "reranking_model": {
            "reranking_provider_name": "",
            "reranking_model_name": ""
        },
        "weights": null,
        "top_k": 1,
        "score_threshold_enabled": false,
        "score_threshold": null
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "query": {
        "content": "test"
    },
    "records": [
        {
            "segment": {
                "id": "7fa6f24f-8679-48b3-bc9d-bdf28d73f218",
                "position": 1,
                "document_id": "a8c6c36f-9f5d-4d7a-8472-f5d7b75d71d2",
                "content": "Operation guide",
                "answer": null,
                "word_count": 847,
                "tokens": 280,
                "keywords": [
                    "install",
                    "java",
                    "base",
                    "scripts",
                    "jdk",
                    "manual",
                    "internal",
                    "opens",
                    "add",
                    "vmoptions"
                ],
                "index_node_id": "39dd8443-d960-45a8-bb46-7275ad7fbc8e",
                "index_node_hash": "0189157697b3c6a418ccf8264a09699f25858975578f3467c76d6bfc94df1d73",
                "hit_count": 0,
                "enabled": true,
                "disabled_at": null,
                "disabled_by": null,
                "status": "completed",
                "created_by": "dbcb1ab5-90c8-41a7-8b78-73b235eb6f6f",
                "created_at": 1728734540,
                "indexing_at": 1728734552,
                "completed_at": 1728734584,
                "error": null,
                "stopped_at": null,
                "document": {
                    "id": "a8c6c36f-9f5d-4d7a-8472-f5d7b75d71d2",
                    "data_source_type": "upload_file",
                    "name": "readme.txt",
                    "doc_type": null
                }
            },
            "score": 3.730463140527718e-05,
            "tsne_position": null
        }
    ]
}

Modified at 2025-01-13 09:31:33

Delete a Chunk in a Document

README