Query Documents

JavaScript

import Honcho from 'honcho-ai';

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

async function main() {
  const documents = await client.apps.users.collections.documents.query(
    'app_id',
    'user_id',
    'collection_id',
    { query: 'x' },
  );

  console.log(documents);
}

main();

import os
from honcho import Honcho

client = Honcho(
    api_key=os.environ.get("HONCHO_API_KEY"),  # This is the default and can be omitted
)
documents = client.apps.users.collections.documents.query(
    collection_id="collection_id",
    app_id="app_id",
    user_id="user_id",
    query="x",
)
print(documents)

curl --request POST \
  --url http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "filter": {},
  "top_k": 5
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'filter' => [
        
    ],
    'top_k' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "collection_id": "<string>",
    "app_id": "<string>",
    "user_id": "<string>",
    "metadata": {}
  }
]

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

POST

apps

{app_id}

users

{user_id}

collections

{collection_id}

documents

query

JavaScript

import Honcho from 'honcho-ai';

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

async function main() {
  const documents = await client.apps.users.collections.documents.query(
    'app_id',
    'user_id',
    'collection_id',
    { query: 'x' },
  );

  console.log(documents);
}

main();

import os
from honcho import Honcho

client = Honcho(
    api_key=os.environ.get("HONCHO_API_KEY"),  # This is the default and can be omitted
)
documents = client.apps.users.collections.documents.query(
    collection_id="collection_id",
    app_id="app_id",
    user_id="user_id",
    query="x",
)
print(documents)

curl --request POST \
  --url http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "filter": {},
  "top_k": 5
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'filter' => [
        
    ],
    'top_k' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/collections/{collection_id}/documents/query")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"filter\": {},\n  \"top_k\": 5\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "collection_id": "<string>",
    "app_id": "<string>",
    "user_id": "<string>",
    "metadata": {}
  }
]

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id

string

required

ID of the app

user_id

string

required

ID of the user

collection_id

string

required

ID of the collection

Body

application/json

Query parameters for document search

query

string

required

Required string length: 1 - 1000

filter

Filter · object | null

top_k

integer

default:5

Required range: 1 <= x <= 50

Response

Successful Response

string

required

content

string

required

created_at

string<date-time>

required

collection_id

string

required

app_id

string

required

user_id

string

required

metadata

Metadata · object

API Documentation

apps

sessions

users

messages

keys

metamessages

collections

documents

Query Documents

Authorizations

Path Parameters

Body

Response