trieve-ts-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.0.121 • Public • Published

A Typescript based SDK that allows you to communicate with the Trieve API

How to use

Install using your favorite package manager:

yarn add trieve-ts-sdk
# or
npm install trieve-ts-sdk
# or
pnpm install trieve-ts-sdk

After installing the first step is to instantiate a new TrieveSDK like so:

import { TrieveSDK } from "trieve-ts-sdk";

export const trieve = new TrieveSDK({
  apiKey: "<your-api-key>",
  datasetId: "<dataset-to-use>",
});

With this done you can use any of the functions available to use trieve in your project and get searching:

import { trieve } from "../trieve";

const data = await trieve.search({
  query: "my first query",
  search_type: "hybrid",
});

To see all the functions we export you can take a look at our docs.

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i trieve-ts-sdk

Weekly Downloads

21,964

Version

0.0.121

License

MIT

Unpacked Size

912 kB

Total Files

87

Last publish

Collaborators

  • trieve