github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_onechat_common.devdocs.json

3960 lines
No EOL
136 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/onechat-common",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createAgentNotFoundError",
"type": "Function",
"tags": [],
"label": "createAgentNotFoundError",
"description": [],
"signature": [
"({ agentId, customMessage, meta, }: { agentId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
"OnechatAgentNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createAgentNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "{\n agentId,\n customMessage,\n meta = {},\n}",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createAgentNotFoundError.$1.agentId",
"type": "Uncategorized",
"tags": [],
"label": "agentId",
"description": [],
"signature": [
"`${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createAgentNotFoundError.$1.customMessage",
"type": "string",
"tags": [],
"label": "customMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createAgentNotFoundError.$1.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createBuiltinToolId",
"type": "Function",
"tags": [],
"label": "createBuiltinToolId",
"description": [
"\nBuild a structured tool identifier for given builtin tool ID."
],
"signature": [
"(plainId: string) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createBuiltinToolId.$1",
"type": "string",
"tags": [],
"label": "plainId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createConversationNotFoundError",
"type": "Function",
"tags": [],
"label": "createConversationNotFoundError",
"description": [],
"signature": [
"({ conversationId, customMessage, meta, }: { conversationId: string; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
"OnechatConversationNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createConversationNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "{\n conversationId,\n customMessage,\n meta = {},\n}",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createConversationNotFoundError.$1.conversationId",
"type": "string",
"tags": [],
"label": "conversationId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createConversationNotFoundError.$1.customMessage",
"type": "string",
"tags": [],
"label": "customMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createConversationNotFoundError.$1.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createInternalError",
"type": "Function",
"tags": [],
"label": "createInternalError",
"description": [],
"signature": [
"(message: string, meta?: Record<string, any> | undefined) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatInternalError",
"text": "OnechatInternalError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createInternalError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createInternalError.$2",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createOnechatError",
"type": "Function",
"tags": [],
"label": "createOnechatError",
"description": [],
"signature": [
"(errorCode: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
", message: string, meta?: Record<string, any> | undefined) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatError",
"text": "OnechatError"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
", Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createOnechatError.$1",
"type": "Enum",
"tags": [],
"label": "errorCode",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createOnechatError.$2",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createOnechatError.$3",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createToolNotFoundError",
"type": "Function",
"tags": [],
"label": "createToolNotFoundError",
"description": [],
"signature": [
"({ toolId, customMessage, meta, }: { toolId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatToolNotFoundError",
"text": "OnechatToolNotFoundError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createToolNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "{\n toolId,\n customMessage,\n meta = {},\n}",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createToolNotFoundError.$1.toolId",
"type": "Uncategorized",
"tags": [],
"label": "toolId",
"description": [],
"signature": [
"`${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createToolNotFoundError.$1.customMessage",
"type": "string",
"tags": [],
"label": "customMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.createToolNotFoundError.$1.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isAgentNotFoundError",
"type": "Function",
"tags": [],
"label": "isAgentNotFoundError",
"description": [
"\nChecks if the given error is a {@link OnechatInternalError}"
],
"signature": [
"(err: unknown) => err is ",
"OnechatAgentNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isAgentNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationCreatedEvent",
"type": "Function",
"tags": [],
"label": "isConversationCreatedEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationCreatedEvent",
"text": "ConversationCreatedEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationCreatedEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationNotFoundError",
"type": "Function",
"tags": [],
"label": "isConversationNotFoundError",
"description": [
"\nChecks if the given error is a {@link OnechatConversationNotFoundError}"
],
"signature": [
"(err: unknown) => err is ",
"OnechatConversationNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationUpdatedEvent",
"type": "Function",
"tags": [],
"label": "isConversationUpdatedEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationUpdatedEvent",
"text": "ConversationUpdatedEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isConversationUpdatedEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isInternalError",
"type": "Function",
"tags": [],
"label": "isInternalError",
"description": [
"\nChecks if the given error is a {@link OnechatInternalError}"
],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatInternalError",
"text": "OnechatInternalError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isInternalError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isMessageChunkEvent",
"type": "Function",
"tags": [],
"label": "isMessageChunkEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageChunkEvent",
"text": "MessageChunkEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isMessageChunkEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isMessageCompleteEvent",
"type": "Function",
"tags": [],
"label": "isMessageCompleteEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageCompleteEvent",
"text": "MessageCompleteEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isMessageCompleteEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isOnechatError",
"type": "Function",
"tags": [],
"label": "isOnechatError",
"description": [],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatError",
"text": "OnechatError"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
", Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isOnechatError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isPlainAgentIdentifier",
"type": "Function",
"tags": [],
"label": "isPlainAgentIdentifier",
"description": [
"\nCheck if the given {@link AgentIdentifier} is a {@link PlainIdAgentIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
},
") => identifier is string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isPlainAgentIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isPlainToolIdentifier",
"type": "Function",
"tags": [],
"label": "isPlainToolIdentifier",
"description": [
"\nCheck if the given {@link ToolIdentifier} is a {@link PlainIdToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
},
") => identifier is string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isPlainToolIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isRoundCompleteEvent",
"type": "Function",
"tags": [],
"label": "isRoundCompleteEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.RoundCompleteEvent",
"text": "RoundCompleteEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isRoundCompleteEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isSerializedAgentIdentifier",
"type": "Function",
"tags": [],
"label": "isSerializedAgentIdentifier",
"description": [
"\nCheck if the given {@link AgentIdentifier} is a {@link SerializedAgentIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
},
") => identifier is `${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isSerializedAgentIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isSerializedToolIdentifier",
"type": "Function",
"tags": [],
"label": "isSerializedToolIdentifier",
"description": [
"\nCheck if the given {@link ToolIdentifier} is a {@link SerializedToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
},
") => identifier is `${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isSerializedToolIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isStructuredAgentIdentifier",
"type": "Function",
"tags": [],
"label": "isStructuredAgentIdentifier",
"description": [
"\nCheck if the given {@link AgentIdentifier} is a {@link StructuredAgentIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
},
") => identifier is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredAgentIdentifier",
"text": "StructuredAgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isStructuredAgentIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isStructuredToolIdentifier",
"type": "Function",
"tags": [],
"label": "isStructuredToolIdentifier",
"description": [
"\nCheck if the given {@link ToolIdentifier} is a {@link StructuredToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
},
") => identifier is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isStructuredToolIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolCallEvent",
"type": "Function",
"tags": [],
"label": "isToolCallEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallEvent",
"text": "ToolCallEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolCallEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolCallStep",
"type": "Function",
"tags": [],
"label": "isToolCallStep",
"description": [],
"signature": [
"(step: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallStep",
"text": "ToolCallStep"
},
") => step is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallStep",
"text": "ToolCallStep"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolCallStep.$1",
"type": "CompoundType",
"tags": [],
"label": "step",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallStep",
"text": "ToolCallStep"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolNotFoundError",
"type": "Function",
"tags": [],
"label": "isToolNotFoundError",
"description": [
"\nChecks if the given error is a {@link OnechatToolNotFoundError}"
],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatToolNotFoundError",
"text": "OnechatToolNotFoundError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolResultEvent",
"type": "Function",
"tags": [],
"label": "isToolResultEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>) => event is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolResultEvent",
"text": "ToolResultEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.isToolResultEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<string, any>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toolDescriptorToIdentifier",
"type": "Function",
"tags": [],
"label": "toolDescriptorToIdentifier",
"description": [],
"signature": [
"(tool: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolDescriptor",
"text": "ToolDescriptor"
},
") => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toolDescriptorToIdentifier.$1",
"type": "Object",
"tags": [],
"label": "tool",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolDescriptor",
"text": "ToolDescriptor"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toSerializedAgentIdentifier",
"type": "Function",
"tags": [],
"label": "toSerializedAgentIdentifier",
"description": [
"\nConvert the given {@link ToolIdentifier} to a {@link SerializedToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
},
") => `${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toSerializedAgentIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toSerializedToolIdentifier",
"type": "Function",
"tags": [],
"label": "toSerializedToolIdentifier",
"description": [
"\nConvert the given {@link ToolIdentifier} to a {@link SerializedToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
},
") => `${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toSerializedToolIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toStructuredAgentIdentifier",
"type": "Function",
"tags": [],
"label": "toStructuredAgentIdentifier",
"description": [
"\nConvert the given {@link ToolIdentifier} to a {@link StructuredToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
},
") => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredAgentIdentifier",
"text": "StructuredAgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toStructuredAgentIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentIdentifier",
"text": "AgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toStructuredToolIdentifier",
"type": "Function",
"tags": [],
"label": "toStructuredToolIdentifier",
"description": [
"\nConvert the given {@link ToolIdentifier} to a {@link StructuredToolIdentifier}"
],
"signature": [
"(identifier: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
},
") => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.toStructuredToolIdentifier.$1",
"type": "CompoundType",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolIdentifier",
"text": "ToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentDescriptor",
"type": "Interface",
"tags": [],
"label": "AgentDescriptor",
"description": [
"\nBase descriptor for an agent."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentDescriptor.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AgentType",
"text": "AgentType"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentDescriptor.agentId",
"type": "string",
"tags": [],
"label": "agentId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentDescriptor.providerId",
"type": "string",
"tags": [],
"label": "providerId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentDescriptor.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AssistantResponse",
"type": "Interface",
"tags": [],
"label": "AssistantResponse",
"description": [
"\nRepresents the final answer from the agent in a conversation round."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AssistantResponse.message",
"type": "string",
"tags": [],
"label": "message",
"description": [
"\nThe text message from the assistant."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation",
"type": "Interface",
"tags": [],
"label": "Conversation",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.agentId",
"type": "Uncategorized",
"tags": [],
"label": "agentId",
"description": [],
"signature": [
"`${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.UserIdAndName",
"text": "UserIdAndName"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.createdAt",
"type": "string",
"tags": [],
"label": "createdAt",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.updatedAt",
"type": "string",
"tags": [],
"label": "updatedAt",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.Conversation.rounds",
"type": "Array",
"tags": [],
"label": "rounds",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationRound",
"text": "ConversationRound"
},
"[]"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationCreatedEventData",
"type": "Interface",
"tags": [],
"label": "ConversationCreatedEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationCreatedEventData.conversationId",
"type": "string",
"tags": [],
"label": "conversationId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationCreatedEventData.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRound",
"type": "Interface",
"tags": [],
"label": "ConversationRound",
"description": [
"\nRepresents a round in a conversation, containing all the information\nrelated to this particular round."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRound.userInput",
"type": "Object",
"tags": [],
"label": "userInput",
"description": [
"The user input that initiated the round"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.RoundInput",
"text": "RoundInput"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRound.steps",
"type": "Array",
"tags": [],
"label": "steps",
"description": [
"List of intermediate steps before the end result, such as tool calls"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallStep",
"text": "ToolCallStep"
},
"[]"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRound.assistantResponse",
"type": "Object",
"tags": [],
"label": "assistantResponse",
"description": [
"The final response from the assistant"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.AssistantResponse",
"text": "AssistantResponse"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationUpdatedEventData",
"type": "Interface",
"tags": [],
"label": "ConversationUpdatedEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationUpdatedEventData.conversationId",
"type": "string",
"tags": [],
"label": "conversationId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationUpdatedEventData.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageChunkEventData",
"type": "Interface",
"tags": [],
"label": "MessageChunkEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageChunkEventData.messageId",
"type": "string",
"tags": [],
"label": "messageId",
"description": [
"ID of the message this chunk is bound to"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageChunkEventData.textChunk",
"type": "string",
"tags": [],
"label": "textChunk",
"description": [
"chunk (text delta)"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageCompleteEventData",
"type": "Interface",
"tags": [],
"label": "MessageCompleteEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageCompleteEventData.messageId",
"type": "string",
"tags": [],
"label": "messageId",
"description": [
"ID of the message"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageCompleteEventData.messageContent",
"type": "string",
"tags": [],
"label": "messageContent",
"description": [
"full text content of the message"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatEvent",
"type": "Interface",
"tags": [],
"label": "OnechatEvent",
"description": [
"\nBase type for all onechat events"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<TEventType, TData>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatEvent.type",
"type": "Uncategorized",
"tags": [],
"label": "type",
"description": [
"\nUnique type identifier for the event."
],
"signature": [
"TEventType"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatEvent.data",
"type": "Uncategorized",
"tags": [],
"label": "data",
"description": [
"\nData bound to this event."
],
"signature": [
"TData"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.RoundCompleteEventData",
"type": "Interface",
"tags": [],
"label": "RoundCompleteEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.RoundCompleteEventData.round",
"type": "Object",
"tags": [],
"label": "round",
"description": [
"round that was completed"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationRound",
"text": "ConversationRound"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.RoundInput",
"type": "Interface",
"tags": [],
"label": "RoundInput",
"description": [
"\nRepresents a user input that initiated a conversation round."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.RoundInput.message",
"type": "string",
"tags": [],
"label": "message",
"description": [
"\nA text message from the user."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredAgentIdentifier",
"type": "Interface",
"tags": [],
"label": "StructuredAgentIdentifier",
"description": [
"\nStructured representation of an agent identifier."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredAgentIdentifier.agentId",
"type": "string",
"tags": [],
"label": "agentId",
"description": [
"The unique ID of this agent, within its provider"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredAgentIdentifier.providerId",
"type": "string",
"tags": [],
"label": "providerId",
"description": [
"Unique ID of the provider this agent is coming from"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredToolIdentifier",
"type": "Interface",
"tags": [],
"label": "StructuredToolIdentifier",
"description": [
"\nStructured representation of a tool identifier."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredToolIdentifier.toolId",
"type": "string",
"tags": [],
"label": "toolId",
"description": [
"The unique ID of this tool, relative to the source"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.StructuredToolIdentifier.providerId",
"type": "string",
"tags": [],
"label": "providerId",
"description": [
"The type of source the tool is being provided from, e.g. builtIn or MCP"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallEventData",
"type": "Interface",
"tags": [],
"label": "ToolCallEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallEventData.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallEventData.toolId",
"type": "Object",
"tags": [],
"label": "toolId",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallEventData.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallWithResult",
"type": "Interface",
"tags": [],
"label": "ToolCallWithResult",
"description": [
"\nRepresents a tool call with the corresponding result."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallWithResult.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [
"\nId of the tool call, as returned by the LLM"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallWithResult.toolId",
"type": "Object",
"tags": [],
"label": "toolId",
"description": [
"\nStructured identifier of the tool."
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallWithResult.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [
"\nArguments the tool was called with."
],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallWithResult.result",
"type": "string",
"tags": [],
"label": "result",
"description": [
"\nResult of the tool, serialized as string."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptor",
"type": "Interface",
"tags": [],
"label": "ToolDescriptor",
"description": [
"\nSerializable representation of a tool, without its handler or schema.\n\nUse as a common base for browser-side and server-side tool types."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptor.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nA unique id for this tool."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptor.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nThe description for this tool, which will be exposed to the LLM."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptor.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [
"\nMeta associated with this tool"
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolDescriptorMeta",
"text": "ToolDescriptorMeta"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptorMeta",
"type": "Interface",
"tags": [],
"label": "ToolDescriptorMeta",
"description": [
"\nMetadata associated with a tool.\n\nSome of them are specified by the tool owner during registration,\nothers are automatically added by the framework."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptorMeta.providerId",
"type": "string",
"tags": [],
"label": "providerId",
"description": [
"\nID of the provider this tool is exposed from."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolDescriptorMeta.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [
"\nOptional list of tags attached to this tool.\nFor built-in tools, this is specified during registration."
],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolResultEventData",
"type": "Interface",
"tags": [],
"label": "ToolResultEventData",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolResultEventData.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolResultEventData.toolId",
"type": "Object",
"tags": [],
"label": "toolId",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolResultEventData.result",
"type": "string",
"tags": [],
"label": "result",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.UserIdAndName",
"type": "Interface",
"tags": [],
"label": "UserIdAndName",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/users.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.UserIdAndName.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/users.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.UserIdAndName.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/users.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatAgentEventType",
"type": "Enum",
"tags": [],
"label": "ChatAgentEventType",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatEventType",
"type": "Enum",
"tags": [],
"label": "ChatEventType",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorCode",
"type": "Enum",
"tags": [],
"label": "OnechatErrorCode",
"description": [
"\nCode to identify onechat errors"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentIdentifier",
"type": "Type",
"tags": [],
"label": "AgentIdentifier",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredAgentIdentifier",
"text": "StructuredAgentIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.AgentType",
"type": "string",
"tags": [],
"label": "AgentType",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.builtinToolProviderId",
"type": "string",
"tags": [],
"label": "builtinToolProviderId",
"description": [
"\nThe singleton sourceId used for all builtIn tools."
],
"signature": [
"\"builtIn\""
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatAgentEvent",
"type": "Type",
"tags": [],
"label": "ChatAgentEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallEvent",
"text": "ToolCallEvent"
},
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolResultEvent",
"text": "ToolResultEvent"
},
" | ",
"ReasoningEvent",
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageChunkEvent",
"text": "MessageChunkEvent"
},
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageCompleteEvent",
"text": "MessageCompleteEvent"
},
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.RoundCompleteEvent",
"text": "RoundCompleteEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatAgentEventBase",
"type": "Type",
"tags": [],
"label": "ChatAgentEventBase",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<TEventType, TData>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatEvent",
"type": "Type",
"tags": [],
"label": "ChatEvent",
"description": [
"\nAll types of events that can be emitted from the chat API."
],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEvent",
"text": "ChatAgentEvent"
},
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationCreatedEvent",
"text": "ConversationCreatedEvent"
},
" | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationUpdatedEvent",
"text": "ConversationUpdatedEvent"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ChatEventBase",
"type": "Type",
"tags": [],
"label": "ChatEventBase",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<TEventType, TData>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationCreatedEvent",
"type": "Type",
"tags": [],
"label": "ConversationCreatedEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatEventType",
"text": "ChatEventType"
},
".conversationCreated, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationCreatedEventData",
"text": "ConversationCreatedEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRoundStep",
"type": "Type",
"tags": [],
"label": "ConversationRoundStep",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallWithResult",
"text": "ToolCallWithResult"
},
" & { type: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationRoundStepType",
"text": "ConversationRoundStepType"
},
"; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationRoundStepType",
"type": "string",
"tags": [],
"label": "ConversationRoundStepType",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ConversationUpdatedEvent",
"type": "Type",
"tags": [],
"label": "ConversationUpdatedEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatEventType",
"text": "ChatEventType"
},
".conversationUpdated, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationUpdatedEventData",
"text": "ConversationUpdatedEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageChunkEvent",
"type": "Type",
"tags": [],
"label": "MessageChunkEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEventType",
"text": "ChatAgentEventType"
},
".messageChunk, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageChunkEventData",
"text": "MessageChunkEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.MessageCompleteEvent",
"type": "Type",
"tags": [],
"label": "MessageCompleteEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEventType",
"text": "ChatAgentEventType"
},
".messageComplete, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.MessageCompleteEventData",
"text": "MessageCompleteEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OneChatDefaultAgentId",
"type": "string",
"tags": [],
"label": "OneChatDefaultAgentId",
"description": [
"\nID of the onechat default conversational agent"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OneChatDefaultAgentProviderId",
"type": "string",
"tags": [],
"label": "OneChatDefaultAgentProviderId",
"description": [
"\nID of the onechat default agent's provider"
],
"signature": [
"\"onechat\""
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatError",
"type": "Type",
"tags": [],
"label": "OnechatError",
"description": [
"\nBase error class used for all onechat errors."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<TCode, TMeta>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatInternalError",
"type": "Type",
"tags": [],
"label": "OnechatInternalError",
"description": [
"\nRepresents an internal error"
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
".internalError, Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatToolNotFoundError",
"type": "Type",
"tags": [],
"label": "OnechatToolNotFoundError",
"description": [
"\nError thrown when trying to retrieve or execute a tool not present or available in the current context."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
".toolNotFound, Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.PlainIdAgentIdentifier",
"type": "Type",
"tags": [],
"label": "PlainIdAgentIdentifier",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.PlainIdToolIdentifier",
"type": "Type",
"tags": [],
"label": "PlainIdToolIdentifier",
"description": [
"\nRepresents a plain toolId, without source information attached to it."
],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.RoundCompleteEvent",
"type": "Type",
"tags": [],
"label": "RoundCompleteEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEventType",
"text": "ChatAgentEventType"
},
".roundComplete, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.RoundCompleteEventData",
"text": "RoundCompleteEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.SerializedAgentIdentifier",
"type": "Type",
"tags": [],
"label": "SerializedAgentIdentifier",
"description": [
"\nString representation of {@link StructuredAgentIdentifier}\nFollow a `{providerId}:{agentId}` format."
],
"signature": [
"`${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/identifiers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.SerializedToolIdentifier",
"type": "Type",
"tags": [],
"label": "SerializedToolIdentifier",
"description": [
"\nString representation of {@link StructuredToolIdentifier}\nFollow a `{toolId}||{sourceType}||{sourceId}` format."
],
"signature": [
"`${string}::${string}`"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallEvent",
"type": "Type",
"tags": [],
"label": "ToolCallEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEventType",
"text": "ChatAgentEventType"
},
".toolCall, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallEventData",
"text": "ToolCallEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolCallStep",
"type": "Type",
"tags": [],
"label": "ToolCallStep",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolCallWithResult",
"text": "ToolCallWithResult"
},
" & { type: ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ConversationRoundStepType",
"text": "ConversationRoundStepType"
},
"; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/chat/conversation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolIdentifier",
"type": "Type",
"tags": [],
"label": "ToolIdentifier",
"description": [
"\nDefines all possible shapes for a tool identifier."
],
"signature": [
"string | ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.StructuredToolIdentifier",
"text": "StructuredToolIdentifier"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolProviderId",
"type": "Type",
"tags": [],
"label": "ToolProviderId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.ToolResultEvent",
"type": "Type",
"tags": [],
"label": "ToolResultEvent",
"description": [],
"signature": [
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatEvent",
"text": "OnechatEvent"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ChatAgentEventType",
"text": "ChatAgentEventType"
},
".toolResult, ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.ToolResultEventData",
"text": "ToolResultEventData"
},
">"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/agents/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.unknownToolProviderId",
"type": "string",
"tags": [],
"label": "unknownToolProviderId",
"description": [
"\nUnknown sourceId used from converting plain Ids to structured or serialized ids."
],
"signature": [
"\"unknown\""
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinTags",
"type": "Object",
"tags": [],
"label": "BuiltinTags",
"description": [
"\nCommon set of tags used for platform tools."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinTags.retrieval",
"type": "string",
"tags": [],
"label": "retrieval",
"description": [
"/**\n * Tag associated to tools related to data retrieval\n */"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds",
"type": "Object",
"tags": [],
"label": "BuiltinToolIds",
"description": [
"\nIds of built-in onechat tools"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.indexExplorer",
"type": "string",
"tags": [],
"label": "indexExplorer",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.relevanceSearch",
"type": "string",
"tags": [],
"label": "relevanceSearch",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.naturalLanguageSearch",
"type": "string",
"tags": [],
"label": "naturalLanguageSearch",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.listIndices",
"type": "string",
"tags": [],
"label": "listIndices",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.getIndexMapping",
"type": "string",
"tags": [],
"label": "getIndexMapping",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.getDocumentById",
"type": "string",
"tags": [],
"label": "getDocumentById",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.generateEsql",
"type": "string",
"tags": [],
"label": "generateEsql",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.executeEsql",
"type": "string",
"tags": [],
"label": "executeEsql",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.BuiltinToolIds.researcherAgent",
"type": "string",
"tags": [],
"label": "researcherAgent",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/tools/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils",
"type": "Object",
"tags": [],
"label": "OnechatErrorUtils",
"description": [
"\nGlobal utility exposing all error utilities from a single export."
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isOnechatError",
"type": "Function",
"tags": [],
"label": "isOnechatError",
"description": [],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatError",
"text": "OnechatError"
},
"<",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatErrorCode",
"text": "OnechatErrorCode"
},
", Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isOnechatError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isInternalError",
"type": "Function",
"tags": [],
"label": "isInternalError",
"description": [],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatInternalError",
"text": "OnechatInternalError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isInternalError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isToolNotFoundError",
"type": "Function",
"tags": [],
"label": "isToolNotFoundError",
"description": [],
"signature": [
"(err: unknown) => err is ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatToolNotFoundError",
"text": "OnechatToolNotFoundError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isToolNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isAgentNotFoundError",
"type": "Function",
"tags": [],
"label": "isAgentNotFoundError",
"description": [],
"signature": [
"(err: unknown) => err is ",
"OnechatAgentNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isAgentNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isConversationNotFoundError",
"type": "Function",
"tags": [],
"label": "isConversationNotFoundError",
"description": [],
"signature": [
"(err: unknown) => err is ",
"OnechatConversationNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.isConversationNotFoundError.$1",
"type": "Unknown",
"tags": [],
"label": "err",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createInternalError",
"type": "Function",
"tags": [],
"label": "createInternalError",
"description": [],
"signature": [
"(message: string, meta?: Record<string, any> | undefined) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatInternalError",
"text": "OnechatInternalError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createInternalError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createInternalError.$2",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createToolNotFoundError",
"type": "Function",
"tags": [],
"label": "createToolNotFoundError",
"description": [],
"signature": [
"({ toolId, customMessage, meta, }: { toolId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
{
"pluginId": "@kbn/onechat-common",
"scope": "common",
"docId": "kibKbnOnechatCommonPluginApi",
"section": "def-common.OnechatToolNotFoundError",
"text": "OnechatToolNotFoundError"
}
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createToolNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ toolId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createAgentNotFoundError",
"type": "Function",
"tags": [],
"label": "createAgentNotFoundError",
"description": [],
"signature": [
"({ agentId, customMessage, meta, }: { agentId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
"OnechatAgentNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createAgentNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ agentId: `${string}::${string}`; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createConversationNotFoundError",
"type": "Function",
"tags": [],
"label": "createConversationNotFoundError",
"description": [],
"signature": [
"({ conversationId, customMessage, meta, }: { conversationId: string; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }) => ",
"OnechatConversationNotFoundError"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/onechat-common",
"id": "def-common.OnechatErrorUtils.createConversationNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ conversationId: string; customMessage?: string | undefined; meta?: Record<string, any> | undefined; }"
],
"path": "x-pack/platform/packages/shared/onechat/onechat-common/base/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink