![PyPI Now Supports iOS and Android Wheels for Mobile Python Development](https://cdn.sanity.io/images/cgdhsj6q/production/96416c872705517a6a65ad9646ce3e7caef623a0-1024x1024.webp?w=400&fit=max&auto=format)
Security News
PyPI Now Supports iOS and Android Wheels for Mobile Python Development
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
@inkeep/chat-api-ts
Advanced tools
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
npm add @inkeep/chat-api-ts
yarn add @inkeep/chat-api-ts
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { InkeepClient } from "@inkeep/chat-api-ts";
async function run() {
const sdk = new InkeepClient({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
Server-sent events are used to stream content from certain
operations. These operations will expose the stream as an async iterable that
can be consumed using a for await...of
loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
import { InkeepClient } from "@inkeep/chat-api-ts";
async function run() {
const sdk = new InkeepClient({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
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.HTTPValidationError | 422 | application/json |
errors.SDKError | 4xx-5xx | / |
Example
import { InkeepClient } from "@inkeep/chat-api-ts";
import * as errors from "@inkeep/chat-api-ts/models/errors";
async function run() {
const sdk = new InkeepClient({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
let result;
try {
result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
} catch (err) {
switch (true) {
case err instanceof errors.HTTPValidationError: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
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 | https://api.inkeep.com | None |
import { InkeepClient } from "@inkeep/chat-api-ts";
async function run() {
const sdk = new InkeepClient({
serverIdx: 0,
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
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:
import { InkeepClient } from "@inkeep/chat-api-ts";
async function run() {
const sdk = new InkeepClient({
serverURL: "https://api.inkeep.com",
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
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:
import { InkeepClient } from "@inkeep/chat-api-ts";
import { HTTPClient } from "@inkeep/chat-api-ts/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 InkeepClient({ httpClient });
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
apiKey | http | HTTP Bearer |
To authenticate with the API the apiKey
parameter must be set when initializing the SDK client instance. For example:
import { InkeepClient } from "@inkeep/chat-api-ts";
async function run() {
const sdk = new InkeepClient({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.createChatSessionWithChatResult({
integrationId: "string",
chatSession: {
messages: [,],
},
});
if (res.chatResult == null) {
throw new Error("failed to create stream: received null value");
}
for await (const event of res.chatResult) {
// Handle the event
}
}
run();
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.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
FAQs
<a href="https://opensource.
We found that @inkeep/chat-api-ts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.