CBK.AI
CBK.AI DOCS
ChatBotKit
GitHub Repo
GitHub Org
Preparing search index...
The search index is not available
ChatBotKit Node SDK
ChatBotKit Node SDK
@chatbotkit/cli
solution
BotResource
Class BotResource
Represents a bot resource.
Hierarchy
Resource
BotResource
Index
Constructors
constructor
Accessors
base
Client
client
description
id
name
slug
type
Methods
sync
Constructors
constructor
new
Bot
Resource
(
config
)
:
BotResource
Parameters
config
:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
properties
?:
{
backstory
?:
string
;
datasetId
?:
string
;
model
?:
string
;
moderation
?:
boolean
;
privacy
?:
boolean
;
skillsetId
?:
string
;
}
;
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
?:
{
datasetId
?:
string
;
url
?:
string
;
}
;
slug
?:
string
;
type
?:
"sitemapIntegration"
;
}
Returns
BotResource
Accessors
base
Client
get
baseClient
(
)
:
ChatBotKit
Returns
ChatBotKit
client
get
client
(
)
:
BotClient
Returns
BotClient
description
get
description
(
)
:
string
Returns
string
id
get
id
(
)
:
string
Returns
string
name
get
name
(
)
:
string
Returns
string
slug
get
slug
(
)
:
string
Returns
string
type
get
type
(
)
:
string
Returns
string
Methods
sync
sync
(
)
:
Promise
<
void
>
Sync the resource.
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
base
Client
client
description
id
name
slug
type
sync
ChatBotKit Node SDK
@chatbotkit/fetch
@chatbotkit/sdk
@chatbotkit/react
@chatbotkit/next
@chatbotkit/nextauth
@chatbotkit/cli
Generated using
TypeDoc
Represents a bot resource.