Skip to content

WIP: feat: create very simple wrappers #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
literalai-client-*.tgz

# Logs
logs
*.log
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"types": "./dist/index.d.ts",
"scripts": {
"build": "tsup ./src",
"test": "jest --runInBand --watchAll=false",
"test": "jest --detectOpenHandles --runInBand --watchAll=false",
"prepare": "husky install"
},
"author": "Literal AI",
Expand Down
26 changes: 19 additions & 7 deletions src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import FormData from 'form-data';
import { createReadStream } from 'fs';
import { v4 as uuidv4 } from 'uuid';

import { LiteralClient } from '.';
import {
GenerationsFilter,
GenerationsOrderBy,
Expand Down Expand Up @@ -327,6 +328,8 @@ function addGenerationsToDatasetQueryBuilder(generationIds: string[]) {
}

export class API {
/** @ignore */
private client: LiteralClient;
/** @ignore */
private apiKey: string;
/** @ignore */
Expand All @@ -339,7 +342,13 @@ export class API {
public disabled: boolean;

/** @ignore */
constructor(apiKey: string, url: string, disabled?: boolean) {
constructor(
client: LiteralClient,
apiKey: string,
url: string,
disabled?: boolean
) {
this.client = client;
this.apiKey = apiKey;
this.url = url;
this.graphqlEndpoint = `${url}/api/graphql`;
Expand Down Expand Up @@ -509,7 +518,9 @@ export class API {

const response = result.data.steps;

response.data = response.edges.map((x: any) => new Step(this, x.node));
response.data = response.edges.map(
(x: any) => new Step(this.client, x.node, true)
);
delete response.edges;

return response;
Expand Down Expand Up @@ -541,7 +552,7 @@ export class API {
return null;
}

return new Step(this, result.data.step);
return new Step(this.client, result.data.step, true);
}

/**
Expand Down Expand Up @@ -878,7 +889,7 @@ export class API {
};

const response = await this.makeGqlCall(query, variables);
return new Thread(this, response.data.upsertThread);
return new Thread(this.client, response.data.upsertThread);
}

/**
Expand Down Expand Up @@ -943,7 +954,9 @@ export class API {

const response = result.data.threads;

response.data = response.edges.map((x: any) => new Thread(this, x.node));
response.data = response.edges.map(
(x: any) => new Thread(this.client, x.node)
);
delete response.edges;

return response;
Expand All @@ -967,12 +980,11 @@ export class API {
const variables = { id };

const response = await this.makeGqlCall(query, variables);

if (!response.data.threadDetail) {
return null;
}

return new Thread(this, response.data.threadDetail);
return new Thread(this.client, response.data.threadDetail);
}

/**
Expand Down
53 changes: 48 additions & 5 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { AsyncLocalStorage } from 'node:async_hooks';

import { API } from './api';
import instrumentation from './instrumentation';
import openai from './openai';
Expand All @@ -8,10 +10,18 @@ export * from './generation';

export type * from './instrumentation';

type StoredContext = {
currentThread: Thread | null;
currentStep: Step | null;
};

const storage = new AsyncLocalStorage<StoredContext>();

export class LiteralClient {
api: API;
openai: ReturnType<typeof openai>;
instrumentation: ReturnType<typeof instrumentation>;
store: AsyncLocalStorage<StoredContext> = storage;

constructor(apiKey?: string, apiUrl?: string, disabled?: boolean) {
if (!apiKey) {
Expand All @@ -22,21 +32,54 @@ export class LiteralClient {
apiUrl = process.env.LITERAL_API_URL || 'https://cloud.getliteral.ai';
}

this.api = new API(apiKey!, apiUrl!, disabled);
this.api = new API(this, apiKey!, apiUrl!, disabled);
this.openai = openai(this);
this.instrumentation = instrumentation(this);
}

thread(data?: ThreadConstructor) {
return new Thread(this.api, data);
return new Thread(this, data);
}

step(data: StepConstructor) {
return new Step(this.api, data);
return new Step(this, data);
}

run(data: Omit<StepConstructor, 'type'>) {
const runData = { ...data, type: 'run' as const };
return new Step(this.api, runData);
return this.step({ ...data, type: 'run' });
}

/**
* Gets the current thread from the context.
* WARNING : this will throw if run outside of a thread context.
* @returns The current thread, if any.
*/
getCurrentThread(): Thread {
const store = storage.getStore();

if (!store?.currentThread) {
throw new Error(
'Literal AI SDK : tried to access current thread outside of a thread context.'
);
}

return store.currentThread;
}

/**
* Gets the current step from the context.
* WARNING : this will throw if run outside of a step context.
* @returns The current step, if any.
*/
getCurrentStep(): Step {
const store = storage.getStore();

if (!store?.currentStep) {
throw new Error(
'Literal AI SDK : tried to access current step outside of a context.'
);
}

return store.currentStep;
}
}
Loading
Loading