71 lines
No EOL
3.6 KiB
Text
71 lines
No EOL
3.6 KiB
Text
---
|
|
id: get-chunk
|
|
title: "Get chunk details"
|
|
description: "Get a specific chunk by its ID"
|
|
sidebar_label: "Get chunk details"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJydVU2P20YM/SsDnhpAK8lOetFtm11sDSRtkHV7qGEYY4myJpE0ypDyriHovxcz+rC07q6D+mJp+Dh8JB+pBhKk2KiKlS4hggdkIQVVGKtUxSLO6vK72J+EYhKrO/BAV2ikBa8SiOCAvHMY8KCSRhbIaAiiTQOlLBAicNadSsADZQNUkjPwwOCPWhlMIGJTowcUZ1hIiBrgU2X9iI0qD+ABK87twUdHZZVA226tP1W6JCTrsgxD+zfP5LGOYyRK61x87cHgQaxLxpItXFZVrmKXS/CNrE8zoVEZmymrLsKYxU8R9CDRcV1gyVdc7npY77WXV4P8JscYPacyweeJhyoZD2gueTnc6Mb4zNeTWVuU9TEoGZOdfNunQ4lbhrb1Bpjef8OYZy3fTFUxLdW5BPP0ZqxndLYvKE9aPZfDYBCFTjAXqTbigNwLHMuk0qpkHzzAZ1lU9sLm3A+oCc1i+f5Ma3K4IyRSutwtduEL3lE4rzesM0VCkeAMRaoMDQR06o6GWvi+P08zgmW4/HATLm4Wv64XYfQ+jMLwnxfVi2BkAq39efBhubycjL9lrhKne3FvjDb/fywSZKly+6QYC7oE5DqeWWV5+jN162Euota7EHC7PWtIGiNPE6V90h1Bq82CDm+J8jMSyQPCeNnrUFcMsbbWa/q1eXWhe9xEh+fydtV9PY27rnz/FWyA/L5ef7m4sOttgZzpfgm79csZRBAcF0GCqaxzDpy2KGgGzbZuCafaFWEIoMqE1CFjYUOJ2y+ri9EZDG5oRnyvGhk71fTb/jMW2pzE44kYC5t5rmK043iG3FYyzlAsfTsstckhgoy5oigInp6efOnMvjaHoPel4NPq4/0fj/c3Sz/0My5ye/ERDXX0Fn7oh/ao0sSFLCexHsYJ75RKL3Nrzsq//unre2RHOahyqZz8XAZNX/0NHBcuhKv/sAxs1GjcG1sPMk1swU2zl4R/mbxt7fGPGs0Jos3Wg6M0Su5tgzYNJIrscwJRKnPCN1L45Wuv0XfiNb6DFEsrxKPMa/sGHnzH0/Rr7aYvQ5mgcRw6820cY8UTx4tlYb/NozAf7tfQtv8CQz/UmA==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api-reference/endpoints/hindsight-http-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Get chunk details"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/default/chunks/{chunk_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get a specific chunk by its ID
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"chunk_id","in":"path","required":true,"schema":{"type":"string","title":"Chunk Id"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"chunk_id":{"type":"string","title":"Chunk Id"},"document_id":{"type":"string","title":"Document Id"},"bank_id":{"type":"string","title":"Bank Id"},"chunk_index":{"type":"integer","title":"Chunk Index"},"chunk_text":{"type":"string","title":"Chunk Text"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["chunk_id","document_id","bank_id","chunk_index","chunk_text","created_at"],"title":"ChunkResponse","description":"Response model for get chunk endpoint.","example":{"bank_id":"user123","chunk_id":"user123_session_1_0","chunk_index":0,"chunk_text":"This is the first chunk of the document...","created_at":"2024-01-15T10:30:00Z","document_id":"session_1"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|