Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/kx-typescript
TypeScript SDK for KX
https://github.com/speakeasy-sdks/kx-typescript
Last synced: 1 day ago
JSON representation
TypeScript SDK for KX
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/kx-typescript
- Owner: speakeasy-sdks
- Created: 2024-07-23T15:12:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T19:47:18.000Z (3 months ago)
- Last Synced: 2024-07-26T22:45:19.306Z (3 months ago)
- Language: TypeScript
- Homepage: https://code.kx.com/insights/1.3/platform/features/api-query.html
- Size: 261 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
AI TypeScript SDK
## 🏗 **Welcome to your new SDK!** 🏗
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/advanced-setup/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
## SDK Installation
### NPM
```bash
npm add https://github.com/speakeasy-sdks/kx-typescript
```
### PNPM
```bash
pnpm add https://github.com/speakeasy-sdks/kx-typescript
```
### Bun
```bash
bun add https://github.com/speakeasy-sdks/kx-typescript
```
### Yarn
```bash
yarn add https://github.com/speakeasy-sdks/kx-typescript zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
```
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Example Usage
### Example
```typescript
import { Kx } from "kx";
const kx = new Kx({
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
## Available Resources and Operations
### [ai](docs/sdks/ai/README.md)
* [insertRaw](docs/sdks/ai/README.md#insertraw) - Insert data into a table.
* [insertJson](docs/sdks/ai/README.md#insertjson) - Insert data into a table.
* [trainRaw](docs/sdks/ai/README.md#trainraw) - Train index on the table (IVF and IVFPQ only).
* [trainJson](docs/sdks/ai/README.md#trainjson) - Train index on the table (IVF and IVFPQ only).
* [vectorSearch](docs/sdks/ai/README.md#vectorsearch) - Vector similarity search
* [hybridSearch](docs/sdks/ai/README.md#hybridsearch) - hybrid similarity search
### [ai.tables](docs/sdks/tables/README.md)
* [list](docs/sdks/tables/README.md#list) - Get a list of existing tables with metadata.
* [getMeta](docs/sdks/tables/README.md#getmeta) - Get table metadata.
* [delete](docs/sdks/tables/README.md#delete) - Drop table.
* [create](docs/sdks/tables/README.md#create) - Create new table.
### [ai.data](docs/sdks/data/README.md)
* [query](docs/sdks/data/README.md#query) - Perform query to get data from a table
### [ai.heath](docs/sdks/heath/README.md)
* [check](docs/sdks/heath/README.md#check) - Health check endpoint, returns 200 OK if the service is operating correctly
### [ai.version](docs/sdks/version/README.md)
* [get](docs/sdks/version/README.md#get) - Check version of kdbai
## File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
> [!TIP]
>
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
>
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
```typescript
import { Kx } from "kx";
const kx = new Kx({
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { Kx } from "kx";
const kx = new Kx({
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"), {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
```
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { Kx } from "kx";
const kx = new Kx({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
## Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.BadRequest | 400 | application/json |
| errors.Unauthorized | 401 | application/json |
| errors.Forbidden | 403 | application/json |
| errors.NotFound | 404 | application/json |
| errors.TooManyRequests | 429 | application/json |
| errors.InternalServerError | 500 | application/json |
| errors.ServiceUnavailable | 503 | application/json |
| errors.SDKError | 4xx-5xx | */* |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
```typescript
import { Kx } from "kx";
import { SDKValidationError } from "kx/models/errors";
const kx = new Kx({
apiKeyAuth: "",
});
async function run() {
let result;
try {
result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
} catch (err) {
switch (true) {
case err instanceof SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case err instanceof errors.BadRequest: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Unauthorized: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Forbidden: {
console.error(err); // handle exception
return;
}
case err instanceof errors.NotFound: {
console.error(err); // handle exception
return;
}
case err instanceof errors.TooManyRequests: {
console.error(err); // handle exception
return;
}
case err instanceof errors.InternalServerError: {
console.error(err); // handle exception
return;
}
case err instanceof errors.ServiceUnavailable: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
run();
```
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `{protocol}://{host}.com` | `protocol` (default is `https`), `host` (default is `cloud.kdb.ai`) |
```typescript
import { Kx } from "kx";
const kx = new Kx({
serverIdx: 0,
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
* `protocol: models.ServerProtocol`
* `host: string`
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
```typescript
import { Kx } from "kx";
const kx = new Kx({
serverURL: "{protocol}://{host}.com",
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
client is a thin wrapper around `fetch` and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the `"beforeRequest"` hook to to add a
custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors:
```typescript
import { Kx } from "kx";
import { HTTPClient } from "kx/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Kx({ httpClient });
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| `apiKeyAuth` | apiKey | API key |
To authenticate with the API the `apiKeyAuth` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { Kx } from "kx";
const kx = new Kx({
apiKeyAuth: "",
});
async function run() {
const result = await kx.ai.insertRaw(new TextEncoder().encode("0x02eF1eFB84"));
// Handle the result
console.log(result);
}
run();
```
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)