Class default

Contains methods for interacting with Carter.

Hierarchy

default

Index

Constructors

Properties

apiKey history logger skills speakDefault

Methods

averageResponseTime context findSkill lastResponseTime latest opener personalise registerSkill say sayAudio

Constructors

constructor

new default(apiKey: string, userLogger?: Logger, speak?: boolean): default
Parameters
- apiKey: string
- Optional userLogger: Logger
- Optional speak: boolean
Returns default
- Defined in src/index.ts:38

Properties

apiKey

apiKey: string

history

history: CarterInteraction[] = []

logger

logger: Logger = ...

skills

skills: CarterSkill[] = []

speakDefault

speakDefault: boolean = false

Methods

averageResponseTime

averageResponseTime(minutes?: number): undefined | number
Returns the average response time for a given number of minutes if given. If not given, the average response time for your the entire history is returned. If there is either no history or no interactions in the given time period, the return value will be undefined.
Parameters
- Optional minutes: number
Returns undefined | number
- Defined in src/index.ts:501

context

context(context: string, userId?: string): Promise<{
error: string;
success: boolean;
}>
Parameters
- context: string
- Optional userId: string
Returns Promise<{
error: string;
success: boolean;
}>
- Defined in src/index.ts:280

findSkill

findSkill(name: string): undefined | CarterSkill
Parameters
- name: string
Returns undefined | CarterSkill
- Defined in src/index.ts:470

lastResponseTime

lastResponseTime(): undefined | number
Returns the response time of your last interaction with Carter

Returns undefined | number
- Defined in src/index.ts:494

latest

latest(): undefined | CarterInteraction
Returns the latest interaction in the conversation history.

Returns undefined | CarterInteraction
- Defined in src/index.ts:485

opener

opener(userId?: string, speak?: boolean): Promise<CarterInteraction>
Parameters
- Optional userId: string
- Optional speak: boolean
Returns Promise<CarterInteraction>
- Defined in src/index.ts:328

personalise

personalise(text: string, userId: string, speak?: boolean): Promise<CarterInteraction>
Parameters
- text: string
- userId: string
- Optional speak: boolean
Returns Promise<CarterInteraction>
- Defined in src/index.ts:392

registerSkill

registerSkill(skill: CarterSkill): undefined | CarterSkill
Parameters
- skill: CarterSkill
Returns undefined | CarterSkill
- Defined in src/index.ts:454

say

say(text: string, userId?: string, context?: string, speak?: boolean): Promise<CarterInteraction>
Parameters
- text: string
- Optional userId: string
- Optional context: string
- Optional speak: boolean
Returns Promise<CarterInteraction>
- Defined in src/index.ts:62

sayAudio

sayAudio(audio: string, userId?: string, speak?: boolean): Promise<CarterInteraction>
Parameters
- audio: string
- Optional userId: string
- Optional speak: boolean
Returns Promise<CarterInteraction>
- Defined in src/index.ts:172

Generated using TypeDoc