Skip to main content
POST
/
knowledge
/
search
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const response = await client.knowledge.search({ collectionIds: ['string'], query: 'x' });

console.log(response.chunks);
{
  "count": 123,
  "chunks": [
    {
      "content": "<string>",
      "score": 123,
      "documentId": "<string>",
      "chunkIndex": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Body

application/json
query
string
required

Natural language search query

Required string length: 1 - 1000
collectionIds
string[]
required

Collection IDs to search

Minimum array length: 1
limit
number
default:5

Maximum number of results

Required range: 1 <= x <= 20
threshold
number
default:0.7

Minimum similarity score (0-1)

Required range: 0 <= x <= 1

Response

Search results

count
number
required

Number of results found

chunks
object[]
required