import { Orchata } from '@orchata-ai/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": {},
"reasoning": "<string>"
}Queries
Query Spaces
Query one or more spaces for similar content. Accepts a single space ID or array of space IDs. Results are merged and globally ranked by default, or can be grouped by space.
POST
/
api
/
query
import { Orchata } from '@orchata-ai/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": {},
"reasoning": "<string>"
}Authorizations
Body
application/json
Query request
Was this page helpful?
⌘I