@taca-app/chat-sdk

v1.0.3

Published

4 months ago

Taca AI Chat SDK

0High
0Medium
0Low

vonuyvico

Taca Chat SDK

Getting Started

Installation

npm install @taca-app/chat-sdk
# or
pnpm add @taca-app/chat-sdk
# or
yarn add @taca-app/chat-sdk

Setup

Create a client with your API key. You can optionally specify a custom baseUrl (defaults to http://localhost:3000/api/v1/chat):

import { TacaAI } from "@taca-app/chat-sdk";

const client = new HayleeAI({
    baseUrl: "http://localhost:3000/api/v1/chat", // optional
});

Basic Usage

Stream a message with optional conversation history:

await client.messages.stream(
  {
    message: "What are my latest spendings?",
    conversation_history: [
      { role: "human", content: "Hello" },
      { role: "ai", content: "Hi! How can I help with tracking your expenses?" },
    ],
  },
  {
    onLlmToken: (ev) => {
      const text = ev.content?.[0]?.text ?? "";
      if (text) process.stdout.write(text);
    },
    onSearchUpdate: (ev) => {
      console.log("Search:", ev.content?.query, ev.status);
    },
    onError: (err) => {
      console.error("Stream error:", err);
    },
    signal: abortController.signal, 
  }
);

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk v1.0.0

Enumerations

Classes

Interfaces

Type Aliases

TacaAIChatClientOptions

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / AuthenticationError

Class: AuthenticationError

Defined in: src/errors/authentication.error.ts:3

Extends

TacaAIError

Constructors

Constructor

new AuthenticationError(message): AuthenticationError

Defined in: src/errors/authentication.error.ts:6

Parameters

message

string

Returns

AuthenticationError

Overrides

TacaAIError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

TacaAIError.cause

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

TacaAIError.message

name

readonly name: string = "AuthenticationError"

Defined in: src/errors/authentication.error.ts:4

Overrides

TacaAIError.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

TacaAIError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TacaAIError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TacaAIError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

TacaAIError.prepareStackTrace

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / AuthorizationError

Class: AuthorizationError

Defined in: src/errors/authorization.error.ts:3

Extends

TacaAIError

Constructors

Constructor

new AuthorizationError(message): AuthorizationError

Defined in: src/errors/authorization.error.ts:6

Parameters

message

string

Returns

AuthorizationError

Overrides

TacaAIError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

TacaAIError.cause

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

TacaAIError.message

name

readonly name: string = "AuthorizationError"

Defined in: src/errors/authorization.error.ts:4

Overrides

TacaAIError.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

TacaAIError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TacaAIError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TacaAIError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

TacaAIError.prepareStackTrace

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / BaseEvent

Class: BaseEvent

Defined in: src/messages/types.ts:13

Base event for Streaming BaseEvent

Extended by

Constructors

Constructor

new BaseEvent(): BaseEvent

Returns

BaseEvent

Properties

kind

kind: EventKind

Defined in: src/messages/types.ts:17

Used to separate streams

node

node: string

Defined in: src/messages/types.ts:21

Source node in langgraph

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / ConversationInfoContent

Class: ConversationInfoContent

Defined in: src/messages/types.ts:55

Constructors

Constructor

new ConversationInfoContent(): ConversationInfoContent

Returns

ConversationInfoContent

Properties

subject

subject: string

Defined in: src/messages/types.ts:57

type

type: "created" | "updated" | "deleted" | "error"

Defined in: src/messages/types.ts:56

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / ConversationInfoEvent

Class: ConversationInfoEvent

Defined in: src/messages/types.ts:51

Base event for Streaming BaseEvent

Extends

BaseEvent

Constructors

Constructor

new ConversationInfoEvent(): ConversationInfoEvent

Returns

ConversationInfoEvent

Inherited from

BaseEvent.constructor

Properties

content

content: ConversationInfoContent

Defined in: src/messages/types.ts:52

kind

kind: EventKind

Defined in: src/messages/types.ts:17

Used to separate streams

Inherited from

BaseEvent.kind

node

node: string

Defined in: src/messages/types.ts:21

Inherited from

BaseEvent.node

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / EndEvent

Class: EndEvent

Defined in: src/messages/types.ts:62

Constructors

Constructor

new EndEvent(): EndEvent

Returns

EndEvent

Properties

success

success: boolean

Defined in: src/messages/types.ts:63

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / LlmTokenContent

Class: LlmTokenContent

Defined in: src/messages/types.ts:28

LLmTokenContent

Constructors

Constructor

new LlmTokenContent(): LlmTokenContent

Returns

LlmTokenContent

Properties

text

text: string

Defined in: src/messages/types.ts:36

type

type: "text"

Defined in: src/messages/types.ts:32

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / LlmTokenEvent

Class: LlmTokenEvent

Defined in: src/messages/types.ts:39

Base event for Streaming BaseEvent

Extends

BaseEvent

Constructors

Constructor

new LlmTokenEvent(): LlmTokenEvent

Returns

LlmTokenEvent

Inherited from

BaseEvent.constructor

Properties

content

content: LlmTokenContent[]

Defined in: src/messages/types.ts:43

kind

kind: EventKind

Defined in: src/messages/types.ts:17

Used to separate streams

Inherited from

BaseEvent.kind

model

model: string

Defined in: src/messages/types.ts:47

node

node: string

Defined in: src/messages/types.ts:21

Inherited from

BaseEvent.node

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / MessageService

Class: MessageService

Defined in: src/messages/message.service.ts:59

Constructors

Constructor

new MessageService(client): MessageService

Defined in: src/messages/message.service.ts:61

Parameters

client

TacaAIClient

Returns

MessageService

Methods

stream()

stream(payload, options?): Promise<void>

Defined in: src/messages/message.service.ts:67

Parameters

payload

CreateMessageDto

The create message payload

options?

MessageServiceOptions

Config for streaming

Returns

Promise<void>

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / NotFoundError

Class: NotFoundError

Defined in: src/errors/not-found.error.ts:3

Extends

TacaAIError

Constructors

Constructor

new NotFoundError(message): NotFoundError

Defined in: src/errors/not-found.error.ts:6

Parameters

message

string

Returns

NotFoundError

Overrides

TacaAIError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

TacaAIError.cause

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

TacaAIError.message

name

readonly name: string = "NotFoundError"

Defined in: src/errors/not-found.error.ts:4

Overrides

TacaAIError.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

TacaAIError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TacaAIError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

TacaAIError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

TacaAIError.prepareStackTrace

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / TacaAI

Class: TacaAI

Defined in: src/index.ts:7

Instantiate a new TacaAI connection

Extends

TacaAIClient

Constructors

Constructor

new TacaAI(options): TacaAI

Defined in: src/index.ts:13

Parameters

options

TacaAIChatClientOptions

TacaAIChatClientOptions

Returns

TacaAI

Overrides

TacaAIClient.constructor

Properties

messages

messages: MessageService

Defined in: src/index.ts:8

Methods

_stream()

_stream(payload, signal?): AsyncGenerator<string>

Defined in: src/_internal/client.ts:37

Internal SSE stream using XMLHttpRequest. XHR onprogress is universally supported in React Native (Hermes) and browsers, unlike fetch + ReadableStream which is not available in RN's fetch polyfill.

Parameters

payload

CreateMessageDto

Message DTO

signal?

AbortSignal

Optional AbortSignal

Returns

AsyncGenerator<string>

Inherited from

TacaAIClient._stream

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / TacaAIClient

Class: TacaAIClient

Defined in: src/_internal/client.ts:17

Internal TacaAI Client. Do not use unless necessary. TacaAIClient

Extended by

TacaAI

Constructors

Constructor

new TacaAIClient(options): TacaAIClient

Defined in: src/_internal/client.ts:21

Parameters

options

TacaAIChatClientOptions

Returns

TacaAIClient

Methods

_stream()

_stream(payload, signal?): AsyncGenerator<string>

Defined in: src/_internal/client.ts:37

Internal SSE stream using XMLHttpRequest. XHR onprogress is universally supported in React Native (Hermes) and browsers, unlike fetch + ReadableStream which is not available in RN's fetch polyfill.

Parameters

payload

CreateMessageDto

Message DTO

signal?

AbortSignal

Optional AbortSignal

Returns

AsyncGenerator<string>

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / TacaAIError

Class: TacaAIError

Defined in: src/errors/base.ts:1

Extends

Error

Extended by

Constructors

Constructor

new TacaAIError(message): TacaAIError

Defined in: src/errors/base.ts:4

Parameters

message

string

Returns

TacaAIError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

readonly name: string = "TacaAIError"

Defined in: src/errors/base.ts:2

Overrides

Error.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

@taca-app/chat-sdk v1.0.0

@taca-app/chat-sdk / ValidationError

Class: ValidationError

Defined in: src/errors/validation.error.ts:3

Extends

TacaAIError

Constructors

Constructor

new ValidationError(message, details?): ValidationError

Defined in: src/errors/validation.error.ts:5

Parameters

message

string

details?

any

Returns

ValidationError

Overrides

TacaAIError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

TacaAIError.cause

details?

optional details: any

Defined in: src/errors/validation.error.ts:5

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

TacaAIError.message

name

readonly name: string = "ValidationError"

Defined in: src/errors/validation.error.ts:4

Overrides

TacaAIError.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

TacaAIError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TacaAIError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();