The Log10 typescript library provides convenient access and type safe models for managing requests and responses from the Log10 REST API powered by fetch.
npm add log10tspnpm add log10tsbun add log10tsyarn add log10ts zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await log10.sessions.create("<value>");
// Handle the result
console.log(result);
}
run();- create - Create a completion
- update - Update completion by id.
- listUngraded - List ungraded completions i.e. completions that have not been associated with feedback but matches task selector.
- create - Create a session
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set X-Log10-Organization to "<value>" at SDK initialization and then you do not have to pass the same value on calls to operations like update. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Required | Description |
|---|---|---|---|
| xLog10Organization | string | The xLog10Organization parameter. |
import {
ChatCompletionRole,
CreateChatCompletionRequestType,
FinishReason,
Kind,
Log10,
ObjectT,
} from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await log10.completions.update(
"<value>",
{
organizationId: "<value>",
kind: Kind.Prompt,
request: {
messages: [
{
content: "<value>",
role: ChatCompletionRole.Assistant,
},
],
model: "gpt-4-turbo",
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
response: {
id: "<id>",
choices: [
{
finishReason: FinishReason.Stop,
index: 344620,
message: {
content: "<value>",
role: ChatCompletionRole.Tool,
},
logprobs: {
content: [
{
token: "<value>",
logprob: 9914.64,
bytes: [270324],
topLogprobs: [
{
token: "<value>",
logprob: 6276.9,
bytes: [684199],
},
],
},
],
},
},
],
created: 488852,
model: "gpt-4-turbo",
object: ObjectT.ChatCompletion,
},
},
"<value>"
);
// Handle the result
console.log(result);
}
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 |
|---|---|---|
| models.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.
import {
ChatCompletionRole,
CreateChatCompletionRequestType,
FinishReason,
Kind,
Log10,
ObjectT,
} from "log10ts";
import { SDKValidationError } from "log10ts/models";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
let result;
try {
result = await log10.completions.create(
{
organizationId: "<value>",
kind: Kind.Chat,
request: {
messages: [
{
role: ChatCompletionRole.Tool,
},
],
model: "gpt-4-turbo",
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
response: {
id: "<id>",
choices: [
{
finishReason: FinishReason.FunctionCall,
index: 417458,
message: {
content: "<value>",
role: ChatCompletionRole.User,
},
logprobs: {
content: [
{
token: "<value>",
logprob: 1343.65,
bytes: [786546],
topLogprobs: [
{
token: "<value>",
logprob: 690.25,
bytes: [996706],
},
],
},
],
},
},
],
created: 796474,
model: "gpt-4-turbo",
object: ObjectT.ChatCompletion,
},
},
"<value>"
);
} 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;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
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://log10.io |
None |
import {
ChatCompletionRole,
CreateChatCompletionRequestType,
FinishReason,
Kind,
Log10,
ObjectT,
} from "log10ts";
const log10 = new Log10({
serverIdx: 0,
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await log10.completions.create(
{
organizationId: "<value>",
kind: Kind.Chat,
request: {
messages: [
{
role: ChatCompletionRole.Tool,
},
],
model: "gpt-4-turbo",
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
response: {
id: "<id>",
choices: [
{
finishReason: FinishReason.FunctionCall,
index: 417458,
message: {
content: "<value>",
role: ChatCompletionRole.User,
},
logprobs: {
content: [
{
token: "<value>",
logprob: 1343.65,
bytes: [786546],
topLogprobs: [
{
token: "<value>",
logprob: 690.25,
bytes: [996706],
},
],
},
],
},
},
],
created: 796474,
model: "gpt-4-turbo",
object: ObjectT.ChatCompletion,
},
},
"<value>"
);
// Handle the result
console.log(result);
}
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 {
ChatCompletionRole,
CreateChatCompletionRequestType,
FinishReason,
Kind,
Log10,
ObjectT,
} from "log10ts";
const log10 = new Log10({
serverURL: "https://log10.io",
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await log10.completions.create(
{
organizationId: "<value>",
kind: Kind.Chat,
request: {
messages: [
{
role: ChatCompletionRole.Tool,
},
],
model: "gpt-4-turbo",
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
response: {
id: "<id>",
choices: [
{
finishReason: FinishReason.FunctionCall,
index: 417458,
message: {
content: "<value>",
role: ChatCompletionRole.User,
},
logprobs: {
content: [
{
token: "<value>",
logprob: 1343.65,
bytes: [786546],
topLogprobs: [
{
token: "<value>",
logprob: 690.25,
bytes: [996706],
},
],
},
],
},
},
],
created: 796474,
model: "gpt-4-turbo",
object: ObjectT.ChatCompletion,
},
},
"<value>"
);
// Handle the result
console.log(result);
}
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 { Log10 } from "log10ts";
import { HTTPClient } from "log10ts/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 Log10({ httpClient });This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
log10Token |
apiKey | API key |
To authenticate with the API the log10Token parameter must be set when initializing the SDK client instance. For example:
import {
ChatCompletionRole,
CreateChatCompletionRequestType,
FinishReason,
Kind,
Log10,
ObjectT,
} from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await log10.completions.create(
{
organizationId: "<value>",
kind: Kind.Chat,
request: {
messages: [
{
role: ChatCompletionRole.Tool,
},
],
model: "gpt-4-turbo",
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
response: {
id: "<id>",
choices: [
{
finishReason: FinishReason.FunctionCall,
index: 417458,
message: {
content: "<value>",
role: ChatCompletionRole.User,
},
logprobs: {
content: [
{
token: "<value>",
logprob: 1343.65,
bytes: [786546],
topLogprobs: [
{
token: "<value>",
logprob: 690.25,
bytes: [996706],
},
],
},
],
},
},
],
created: 796474,
model: "gpt-4-turbo",
object: ObjectT.ChatCompletion,
},
},
"<value>"
);
// Handle the result
console.log(result);
}
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!