API Reference

Retrieve similar chunks

post
https://api.instill-ai.com/v1alpha/namespaces//catalogs//chunks/retrieve

Returns the top-K most similar chunks to a text prompt.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the namespace owning the catalog.

string
required

ID of the catalog.

Body Params
string
required

Text prompt to look for similarities.

int64

Top K. Default value: 5.

string
enum

ContentType describes the type of a chunk content.

  • CONTENT_TYPE_CHUNK: Chunk.
  • CONTENT_TYPE_SUMMARY: Summary.
  • CONTENT_TYPE_AUGMENTED: Augmented.
Allowed:
string
enum

FileMediaType describes the type of a catalog file.

  • FILE_MEDIA_TYPE_DOCUMENT: Document.
  • FILE_MEDIA_TYPE_IMAGE: Image.
  • FILE_MEDIA_TYPE_AUDIO: Audio.
  • FILE_MEDIA_TYPE_VIDEO: Video.
Allowed:
fileUids
array of strings

File UIDs. When this field is provided, the response will return only chunks that belong to the specified file UIDs.

fileUids
Headers
string

Indicates the authenticated namespace is making the request on behalf of another entity, typically an organization they belong to

Responses

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago