Skip to main content
POST
/
query
import { Orchata } from '@orchata/sdk';

const client = new Orchata({ apiKey: 'oai_your_api_key' });

const { results } = await client.query({
  spaceIds: 'space_123',
  query: 'How do I authenticate?'
});

for (const result of results) {
  console.log(`Score: ${result.similarity}`);
  console.log(`Content: ${result.chunk.content}`);
}
{
  "results": [
    {
      "chunk": {
        "id": "<string>",
        "content": "<string>",
        "chunkIndex": 123
      },
      "document": {
        "id": "<string>",
        "filename": "<string>",
        "metadata": {}
      },
      "space": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>"
      },
      "similarity": 123,
      "metadata": {}
    }
  ],
  "totalResults": 123,
  "groupedBySpace": {}
}

Authorizations

​
Oai-Api-Key
string
header
required

Body

application/json

Query request

​
query
string
required
Minimum string length: 1
​
spaceIds
required
​
topK
integer
default:10
Required range: 1 <= x <= 100
​
threshold
number
default:0
Required range: 0 <= x <= 1
​
metadata
object
​
groupBySpace
boolean
default:false

Response

Successfully retrieved query results

​
results
object[]
required
​
totalResults
number
required
​
groupedBySpace
object