createTool

Creates a tool with a schema.

API

declare function createTool<
  const Name extends string,
  Schema extends  s.HashbrownType ,
  Result,
>(input: {
  name: Name;
  description: string;
  schema: Schema;
  handler: (
    input:  s.Infer <Schema>,
    abortSignal:  AbortSignal ,
  ) =>  Promise <Result>;
}):  Chat.Tool <
  Name,
   s.Infer <Schema>,
  Result
>;

@paraminput:

{
    name: Name;
    description: string;
    schema: Schema;
    handler: (input: s.Infer<Schema>, abortSignal: AbortSignal) => Promise<Result>;
}

The input for the tool.

@typeName

string

@typeSchema

s.HashbrownType

@typeResult

@returns

Chat.Tool<Name, s.Infer<Schema>, Result>

createTool

Creates a tool with a unknown JSON schema.

API

declare function createTool<const Name extends string, Result>(input: {
  name: Name;
  description: string;
  schema: object;
  handler: (
    input: any,
    abortSignal:  AbortSignal ,
  ) =>  Promise <Result>;
}):  Chat.Tool <Name, any, Result>;

@paraminput:

{
    name: Name;
    description: string;
    schema: object;
    handler: (input: any, abortSignal: AbortSignal) => Promise<Result>;
}

The input for the tool.

@typeName

string

@typeResult

@returns

Chat.Tool<Name, any, Result>

createTool

Creates a tool without a schema.

API

declare function createTool<const Name extends string, Result>(input: {
  name: Name;
  description: string;
  handler: (
    abortSignal:  AbortSignal ,
  ) =>  Promise <Result>;
}):  Chat.Tool <Name, void, Result>;

@paraminput:

{
    name: Name;
    description: string;
    handler: (abortSignal: AbortSignal) => Promise<Result>;
}

The input for the tool.

@typeName

string

@typeResult

@returns

Chat.Tool<Name, void, Result>