API reference / Knowledge and vector search

Search documents by meaning

POSThttps://ai.inovacc.dev/v1/vector/query

Find the passages closest in meaning to a question, best first.

Body params

mode"local" | "shared" | "hybrid"required
Which scope to search; hybrid searches both and merges by score.
querystringrequired
The question or text to match, 1 to 8,000 characters.
top_kinteger
How many matches to return, 1 to 50. Default 5.
filterobject
Equality on the filterable metadata keys, or {"$in": [...]} with up to 20 values.
retrieval"vector" | "vector_rerank"
vector_rerank re-orders a wider candidate list with a reranking stage. Default vector.
rerank_profilestring
The rerank profile to use; required with vector_rerank and refused otherwise.

Headers

Authorizationstringrequired
Bearer <API key>
X-Operation-Idstringrequired
a unique id you choose, on every call except GET
Content-Typestringrequired
application/json, on a call with a body

import crypto from "node:crypto"; const body: Record<string, unknown> = { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } }; const url = "https://ai.inovacc.dev/v1/vector/query"; const response = await fetch(url, { method: "POST", headers: { Authorization: `Bearer ${process.env.INOVACC_API_KEY}`, "X-Operation-Id": crypto.randomUUID(), "Content-Type": "application/json", }, body: JSON.stringify(body), }); console.log(response.status, await response.text());

import json import os import urllib.request import uuid body = { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr", }, } request = urllib.request.Request( "https://ai.inovacc.dev/v1/vector/query", data=json.dumps(body).encode(), method="POST", headers={ "User-Agent": "inovacc-python-sample", "Authorization": "Bearer " + os.environ["INOVACC_API_KEY"], "X-Operation-Id": str(uuid.uuid4()), "Content-Type": "application/json", }, ) with urllib.request.urlopen(request) as response: print(response.status, response.read().decode())

package main import ( "crypto/rand" "fmt" "io" "net/http" "os" "strings" ) const url = "https://ai.inovacc.dev/v1/vector/query" const body = `{ "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } }` // newUUID returns a random (version 4) UUID, from the standard library alone. func newUUID() string { b := make([]byte, 16) if _, err := rand.Read(b); err != nil { panic(err) } b[6] = b[6]&0x0f | 0x40 b[8] = b[8]&0x3f | 0x80 return fmt.Sprintf("%x-%x-%x-%x-%x", b[0:4], b[4:6], b[6:8], b[8:10], b[10:]) } func main() { req, err := http.NewRequest("POST", url, strings.NewReader(body)) if err != nil { panic(err) } req.Header.Set("Authorization", "Bearer "+os.Getenv("INOVACC_API_KEY")) req.Header.Set("X-Operation-Id", newUUID()) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, err := io.ReadAll(res.Body) if err != nil { panic(err) } fmt.Println(res.Status, string(out)) }

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] } // Cargo.toml: serde_json = "1" // Cargo.toml: uuid = { version = "1", features = ["v4"] } fn main() -> Result<(), Box<dyn std::error::Error>> { let api_key = std::env::var("INOVACC_API_KEY")?; let body = serde_json::json!({ "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } }); let response = reqwest::blocking::Client::new() .post("https://ai.inovacc.dev/v1/vector/query") .bearer_auth(api_key) .header("X-Operation-Id", uuid::Uuid::new_v4().to_string()) .json(&body) .send()?; println!("{} {}", response.status(), response.text()?); Ok(()) }

import crypto from "node:crypto"; const body = { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } }; const url = "https://ai.inovacc.dev/v1/vector/query"; const response = await fetch(url, { method: "POST", headers: { Authorization: `Bearer ${process.env.INOVACC_API_KEY}`, "X-Operation-Id": crypto.randomUUID(), "Content-Type": "application/json", }, body: JSON.stringify(body), }); console.log(response.status, await response.text());

<?php $body = <<<'JSON' { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } } JSON; function uuid4(): string { $bytes = random_bytes(16); $bytes[6] = chr(ord($bytes[6]) & 0x0f | 0x40); $bytes[8] = chr(ord($bytes[8]) & 0x3f | 0x80); return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($bytes), 4)); } $curl = curl_init('https://ai.inovacc.dev/v1/vector/query'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('INOVACC_API_KEY'), 'X-Operation-Id: ' . uuid4(), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => $body, ]); $response = curl_exec($curl); echo curl_getinfo($curl, CURLINFO_HTTP_CODE), ' ', $response, "\n"; curl_close($curl);

require "net/http" require "securerandom" require "uri" uri = URI('https://ai.inovacc.dev/v1/vector/query') body = <<~'JSON' { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } } JSON request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer #{ENV.fetch('INOVACC_API_KEY')}" request["X-Operation-Id"] = SecureRandom.uuid request["Content-Type"] = "application/json" request.body = body response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end puts "#{response.code} #{response.body}"

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.util.UUID; public class Main { public static void main(String[] args) throws Exception { String apiKey = System.getenv("INOVACC_API_KEY"); String body = "{" + "\"mode\": \"shared\"," + "\"query\": \"How much paid leave do I get?\"," + "\"top_k\": 3," + "\"filter\": {" + "\"category\": \"hr\"" + "}" + "}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://ai.inovacc.dev/v1/vector/query")) .header("Authorization", "Bearer " + apiKey) .header("X-Operation-Id", UUID.randomUUID().toString()) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(body)) .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode() + " " + response.body()); } }

using System.Text; var body = "{" + "\"mode\": \"shared\"," + "\"query\": \"How much paid leave do I get?\"," + "\"top_k\": 3," + "\"filter\": {" + "\"category\": \"hr\"" + "}" + "}"; var url = "https://ai.inovacc.dev/v1/vector/query"; var apiKey = Environment.GetEnvironmentVariable("INOVACC_API_KEY"); using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, url); request.Headers.Add("Authorization", $"Bearer {apiKey}"); request.Headers.Add("X-Operation-Id", Guid.NewGuid().ToString()); request.Content = new StringContent(body, Encoding.UTF8, "application/json"); using var response = await client.SendAsync(request); Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

import java.net.URI import java.net.http.HttpClient import java.net.http.HttpRequest import java.net.http.HttpResponse import java.util.UUID fun main() { val apiKey = System.getenv("INOVACC_API_KEY") val body = "{" + "\"mode\": \"shared\"," + "\"query\": \"How much paid leave do I get?\"," + "\"top_k\": 3," + "\"filter\": {" + "\"category\": \"hr\"" + "}" + "}" val request = HttpRequest.newBuilder() .uri(URI.create("https://ai.inovacc.dev/v1/vector/query")) .header("Authorization", "Bearer " + apiKey) .header("X-Operation-Id", UUID.randomUUID().toString()) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(body)) .build() val response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()) println("${response.statusCode()} ${response.body()}") }

import Foundation #if canImport(FoundationNetworking) import FoundationNetworking #endif let body = #""" { "mode": "shared", "query": "How much paid leave do I get?", "top_k": 3, "filter": { "category": "hr" } } """# let apiKey = ProcessInfo.processInfo.environment["INOVACC_API_KEY"] ?? "" let url = URL(string: "https://ai.inovacc.dev/v1/vector/query")! var request = URLRequest(url: url) request.httpMethod = "POST" request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization") request.setValue(UUID().uuidString, forHTTPHeaderField: "X-Operation-Id") request.setValue("application/json", forHTTPHeaderField: "Content-Type") request.httpBody = Data(body.utf8) let (data, response) = try await URLSession.shared.data(for: request) let status = (response as? HTTPURLResponse)?.statusCode ?? 0 print(status, String(decoding: data, as: UTF8.self))

{ "matches": [ { "id": "handbook-leave-1", "score": 0.83, "text": "Employees accrue two and a half days of paid leave per month.", "metadata": { "category": "hr" } } ], "retrieval": { "mode": "vector", "reranked": false, "profile": null, "outcome": "none" } }

Search documents by meaning

Body params

Headers

See also