Class Solution

Represents a solution.

Hierarchy

Solution

Index

Constructors

Accessors

baseClient bot bots dataset datasets resources sitemapIntegration sitemapIntegrations skillset skillsets widgetIntegration widgetIntegrations

Methods

sync create delete list load save

Constructors

constructor

new Solution(config): Solution
Parameters
- config: {
      resources?: ({
          description?: string;
          id?: string;
          name?: string;
          properties?: { model?: string; backstory?: string; datasetId?: string; skillsetId?: string; moderation?: boolean; privacy?: boolean; };
          slug?: string;
          type?: "bot";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "dataset";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "skillset";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "widgetIntegration";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: { url?: string; datasetId?: string; };
          slug?: string;
          type?: "sitemapIntegration";
      })[];
      version?: 1;
  }
  - Optional resources?: ({
        description?: string;
        id?: string;
        name?: string;
        properties?: { model?: string; backstory?: string; datasetId?: string; skillsetId?: string; moderation?: boolean; privacy?: boolean; };
        slug?: string;
        type?: "bot";
    } | {
        description?: string;
        id?: string;
        name?: string;
        properties?: {};
        slug?: string;
        type?: "dataset";
    } | {
        description?: string;
        id?: string;
        name?: string;
        properties?: {};
        slug?: string;
        type?: "skillset";
    } | {
        description?: string;
        id?: string;
        name?: string;
        properties?: {};
        slug?: string;
        type?: "widgetIntegration";
    } | {
        description?: string;
        id?: string;
        name?: string;
        properties?: { url?: string; datasetId?: string; };
        slug?: string;
        type?: "sitemapIntegration";
    })[]
  - Optional version?: 1
Returns Solution
- Defined in packages/cli/src/solution/index.js:350

Accessors

baseClient

get baseClient(): ChatBotKit
Returns ChatBotKit
- Defined in packages/cli/src/solution/index.js:357

bot

get bot(): {
[key: string]: BotResource | undefined;
}
Returns {
[key: string]: BotResource | undefined;
}
- [key: string]: BotResource | undefined
- Defined in packages/cli/src/solution/index.js:402

bots

get bots(): BotResource[]
Returns BotResource[]
- Defined in packages/cli/src/solution/index.js:393

dataset

get dataset(): {
[key: string]: DatasetResource | undefined;
}
Returns {
[key: string]: DatasetResource | undefined;
}
- [key: string]: DatasetResource | undefined
- Defined in packages/cli/src/solution/index.js:418

datasets

get datasets(): DatasetResource[]
Returns DatasetResource[]
- Defined in packages/cli/src/solution/index.js:409

resources

get resources(): (BotResource | DatasetResource | SkillsetResource | WidgetIntegrationResource | SitemapIntegrationResource)[]
Get the resources.

Returns (BotResource | DatasetResource | SkillsetResource | WidgetIntegrationResource | SitemapIntegrationResource)[]
- Defined in packages/cli/src/solution/index.js:371

sitemapIntegration

get sitemapIntegration(): {
[key: string]: SitemapIntegrationResource | undefined;
}
Returns {
[key: string]: SitemapIntegrationResource | undefined;
}
- [key: string]: SitemapIntegrationResource | undefined
- Defined in packages/cli/src/solution/index.js:470

sitemapIntegrations

get sitemapIntegrations(): SitemapIntegrationResource[]
Returns SitemapIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:459

skillset

get skillset(): {
[key: string]: SkillsetResource | undefined;
}
Returns {
[key: string]: SkillsetResource | undefined;
}
- [key: string]: SkillsetResource | undefined
- Defined in packages/cli/src/solution/index.js:434

skillsets

get skillsets(): SkillsetResource[]
Returns SkillsetResource[]
- Defined in packages/cli/src/solution/index.js:425

widgetIntegration

get widgetIntegration(): {
[key: string]: WidgetIntegrationResource | undefined;
}
Returns {
[key: string]: WidgetIntegrationResource | undefined;
}
- [key: string]: WidgetIntegrationResource | undefined
- Defined in packages/cli/src/solution/index.js:452

widgetIntegrations

get widgetIntegrations(): WidgetIntegrationResource[]
Returns WidgetIntegrationResource[]
- Defined in packages/cli/src/solution/index.js:441

Methods

sync

sync(): Promise<void>
Sync the solution.

Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:479

`Static` create

create(name): Promise<void>
Creates a new solution.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:505

`Static` delete

delete(name): Promise<void>
Deletes a solution.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:530

`Static` list

list(): Promise<string[]>
Lists solutions.

Returns Promise<string[]>
- Defined in packages/cli/src/solution/index.js:489

`Static` load

load(config): Promise<Solution>
Loads a solution from a configuration object or a file.
Parameters
- config: string | {
      resources?: ({
          description?: string;
          id?: string;
          name?: string;
          properties?: { model?: string; backstory?: string; datasetId?: string; skillsetId?: string; moderation?: boolean; privacy?: boolean; };
          slug?: string;
          type?: "bot";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "dataset";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "skillset";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: {};
          slug?: string;
          type?: "widgetIntegration";
      } | {
          description?: string;
          id?: string;
          name?: string;
          properties?: { url?: string; datasetId?: string; };
          slug?: string;
          type?: "sitemapIntegration";
      })[];
      version?: 1;
  }
Returns Promise<Solution>
- Defined in packages/cli/src/solution/index.js:547

`Static` save

save(name, solution): Promise<void>
Saves a solution to a file.
Parameters
- name: string
- solution: Solution
Returns Promise<void>
- Defined in packages/cli/src/solution/index.js:586

Class Solution

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional version?: 1

Returns Solution

Accessors

baseClient

Returns ChatBotKit

bot

Returns { [key: string]: BotResource | undefined; }

[key: string]: BotResource | undefined

bots

Returns BotResource[]

dataset

Returns { [key: string]: DatasetResource | undefined; }

[key: string]: DatasetResource | undefined

datasets

Returns DatasetResource[]

resources

Returns (BotResource | DatasetResource | SkillsetResource | WidgetIntegrationResource | SitemapIntegrationResource)[]

sitemapIntegration

Returns { [key: string]: SitemapIntegrationResource | undefined; }

[key: string]: SitemapIntegrationResource | undefined

sitemapIntegrations

Returns SitemapIntegrationResource[]

skillset

Returns { [key: string]: SkillsetResource | undefined; }

[key: string]: SkillsetResource | undefined

skillsets

Returns SkillsetResource[]

widgetIntegration

Returns { [key: string]: WidgetIntegrationResource | undefined; }

[key: string]: WidgetIntegrationResource | undefined

widgetIntegrations

Returns WidgetIntegrationResource[]

Methods

sync

Returns Promise<void>

Static create

Parameters

name: string

Returns Promise<void>

Static delete

Parameters

name: string

Returns Promise<void>

Static list

Returns Promise<string[]>

Static load

Parameters

Returns Promise<Solution>

Static save

Parameters

name: string

solution: Solution

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` version?: 1

Returns {
[key: string]: BotResource | undefined;
}

Returns {
[key: string]: DatasetResource | undefined;
}

Returns {
[key: string]: SitemapIntegrationResource | undefined;
}

Returns {
[key: string]: SkillsetResource | undefined;
}

Returns {
[key: string]: WidgetIntegrationResource | undefined;
}

`Static` create

`Static` delete

`Static` list

`Static` load

`Static` save