Retrieve Chunks

POST 
/api/chunks/retrieve

Retrieve chunks based on a given query.

Request

application/json

Body

required

collection Collectionrequired
query Queryrequired
n N

Default value: 10

include_text_chunks Include Text Chunks

Default value: true

include_image_chunks Include Image Chunks

Default value: true

include_summary Include Summary

Default value: false

Responses

200

Successful Response

application/json

Schema

Schema

summary

object

required

anyOf

MOD1

string

text_results

object[]

required

Array [

chunk_id Chunk Idrequired

document_id Document Idrequired

score Scorerequired

text Textrequired

raw Rawrequired

start_char_idx

object

Start char index of the chunk.

anyOf

MOD1

integer

end_char_idx

object

End char index of the chunk.

anyOf

MOD1

integer

]

image_results

object[]

required

Array [

chunk_id Chunk Idrequired

document_id Document Idrequired

score Scorerequired

image

object

required

Image of the node.

anyOf

MOD1

string

image_mimetype

object

required

Mimetype of the image.

anyOf

MOD1

string

image_path

object

required

Path of the image.

anyOf

MOD1

string

image_url

object

required

URL of the image.

anyOf

MOD1

string

]

Example (from schema)

{
  "summary": "string",
  "text_results": [
    {
      "chunk_id": 0,
      "document_id": 0,
      "score": 0,
      "text": "string",
      "raw": true,
      "start_char_idx": 0,
      "end_char_idx": 0
    }
  ],
  "image_results": [
    {
      "chunk_id": 0,
      "document_id": 0,
      "score": 0,
      "image": "string",
      "image_mimetype": "string",
      "image_path": "string",
      "image_url": "string"
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Messagerequired

type Error Typerequired

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...