{ "id": "@kbn/onechat-server", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase", "type": "Interface", "tags": [], "label": "AgentDefinitionBase", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentDefinitionBase", "text": "AgentDefinitionBase" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "TType" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, ", context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerReturn", "text": "AgentHandlerReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.handler.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinitionBase.handler.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentEventEmitter", "type": "Interface", "tags": [], "label": "AgentEventEmitter", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentEventEmitter.emit", "type": "Function", "tags": [], "label": "emit", "description": [], "signature": [ "(event: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ChatAgentEvent", "text": "ChatAgentEvent" }, ") => void" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentEventEmitter.emit.$1", "type": "CompoundType", "tags": [], "label": "event", "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-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext", "type": "Interface", "tags": [], "label": "AgentHandlerContext", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.request", "type": "Object", "tags": [], "label": "request", "description": [ "\nThe request that was provided when initiating that tool execution.\nCan be used to create scoped services not directly exposed by this context." ], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [ "\nA cluster client scoped to the current user.\nCan be used to access ES on behalf of either the current user or the system user." ], "signature": [ "IScopedClusterClient" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.modelProvider", "type": "Object", "tags": [], "label": "modelProvider", "description": [ "\nInference model provider scoped to the current user.\nCan be used to access the inference APIs or chatModel." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ModelProvider", "text": "ModelProvider" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.toolProvider", "type": "Object", "tags": [], "label": "toolProvider", "description": [ "\nTool provider that can be used to list or execute tools." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProvider", "text": "ToolProvider" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.runner", "type": "Object", "tags": [], "label": "runner", "description": [ "\nOnechat runner scoped to the current execution.\nCan be used to run other workchat primitive as part of the tool execution." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunner", "text": "ScopedRunner" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerContext.events", "type": "Object", "tags": [], "label": "events", "description": [ "\nEvent emitter that can be used to emits custom events" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentEventEmitter", "text": "AgentEventEmitter" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerParams", "type": "Interface", "tags": [], "label": "AgentHandlerParams", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerParams.agentParams", "type": "Uncategorized", "tags": [], "label": "agentParams", "description": [ "The params that the agent execution API was called with" ], "signature": [ "TParams" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerParams.runId", "type": "string", "tags": [], "label": "runId", "description": [ "ID of this run" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerReturn", "type": "Interface", "tags": [], "label": "AgentHandlerReturn", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerReturn", "text": "AgentHandlerReturn" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerReturn.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "The plain result of the agent" ], "signature": [ "TResult" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider", "type": "Interface", "tags": [], "label": "AgentProvider", "description": [ "\nProvider that can be registered to expose agents to onechat" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentProvider", "text": "AgentProvider" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.has", "type": "Function", "tags": [], "label": "has", "description": [], "signature": [ "(opts: { agentId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentIdentifier", "text": "AgentIdentifier" }, "; request: ", "KibanaRequest", "; }) => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.has.$1", "type": "Object", "tags": [], "label": "opts", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.has.$1.agentId", "type": "CompoundType", "tags": [], "label": "agentId", "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-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.has.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(opts: { agentId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentIdentifier", "text": "AgentIdentifier" }, "; request: ", "KibanaRequest", "; }) => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.get.$1", "type": "Object", "tags": [], "label": "opts", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.get.$1.agentId", "type": "CompoundType", "tags": [], "label": "agentId", "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-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.get.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.list", "type": "Function", "tags": [], "label": "list", "description": [], "signature": [ "(opts: { request: ", "KibanaRequest", "; }) => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.list.$1", "type": "Object", "tags": [], "label": "opts", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentProvider.list.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentDefinition", "type": "Interface", "tags": [], "label": "ConversationalAgentDefinition", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentDefinition", "text": "ConversationalAgentDefinition" }, " extends ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentDefinitionBase", "text": "AgentDefinitionBase" }, "<", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentType", "text": "AgentType" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentParams", "text": "ConversationalAgentParams" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentResponse", "text": "ConversationalAgentResponse" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentDefinition.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-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentDefinition.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentParams", "text": "ConversationalAgentParams" }, ">, context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerReturn", "text": "AgentHandlerReturn" }, "<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentResponse", "text": "ConversationalAgentResponse" }, ">>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentDefinition.handler.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentDefinition.handler.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentParams", "type": "Interface", "tags": [], "label": "ConversationalAgentParams", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentParams.conversation", "type": "Array", "tags": [], "label": "conversation", "description": [], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ConversationRound", "text": "ConversationRound" }, "[] | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentParams.nextInput", "type": "Object", "tags": [], "label": "nextInput", "description": [], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.RoundInput", "text": "RoundInput" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentResponse", "type": "Interface", "tags": [], "label": "ConversationalAgentResponse", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentResponse.round", "type": "Object", "tags": [], "label": "round", "description": [ "\nThe full round of conversation, can be used for persistence for example." ], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ConversationRound", "text": "ConversationRound" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase", "type": "Interface", "tags": [], "label": "ExecutableAgentBase", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableAgentBase", "text": "ExecutableAgentBase" }, " extends ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentDescriptor", "text": "AgentDescriptor" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "TType" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.agentId", "type": "string", "tags": [], "label": "agentId", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.providerId", "type": "string", "tags": [], "label": "providerId", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableAgentHandlerParams", "text": "ExecutableAgentHandlerParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentBase.execute.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableTool", "type": "Interface", "tags": [], "label": "ExecutableTool", "description": [ "\nOnechat tool, as exposed by the onechat tool registry." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableTool", "text": "ExecutableTool" }, " extends ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ToolDescriptor", "text": "ToolDescriptor" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableTool.schema", "type": "Uncategorized", "tags": [], "label": "schema", "description": [ "\nTool's input schema, defined as a zod schema." ], "signature": [ "RunInput" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableTool.execute", "type": "Function", "tags": [], "label": "execute", "description": [ "\nRun handler that can be used to execute the tool." ], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableToolHandlerParams", "text": "ExecutableToolHandlerParams" }, ">) => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableTool.execute.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ModelProvider", "type": "Interface", "tags": [], "label": "ModelProvider", "description": [ "\nProvider, allowing to select various models depending on the needs." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ModelProvider.getDefaultModel", "type": "Function", "tags": [], "label": "getDefaultModel", "description": [ "\nReturns the default model to be used for LLM tasks.\n\nWill use Elasticsearch LLMs by default if present, otherwise will pick\nthe first GenAI compatible connector." ], "signature": [ "() => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedModel", "text": "ScopedModel" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ModelProvider.getModel", "type": "Function", "tags": [], "label": "getModel", "description": [ "\nReturns a model using the given connectorId.\n\nWill throw if connector doesn't exist, user has no access, or connector\nis not a GenAI connector." ], "signature": [ "(options: { connectorId: string; }) => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedModel", "text": "ScopedModel" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ModelProvider.getModel.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ModelProvider.getModel.$1.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool", "type": "Interface", "tags": [], "label": "RegisteredTool", "description": [ "\nOnechat tool, as registered by built-in tool providers." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RegisteredTool", "text": "RegisteredTool" }, " extends Omit<", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ToolDescriptor", "text": "ToolDescriptor" }, ", \"meta\">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool.schema", "type": "Uncategorized", "tags": [], "label": "schema", "description": [ "\nTool's input schema, defined as a zod schema." ], "signature": [ "RunInput" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool.handler", "type": "Function", "tags": [], "label": "handler", "description": [ "\nHandler to call to execute the tool." ], "signature": [ "(args: Zod.TypeOf, context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolHandlerContext", "text": "ToolHandlerContext" }, ") => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool.handler.$1", "type": "Uncategorized", "tags": [], "label": "args", "description": [], "signature": [ "TParams" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool.handler.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolHandlerContext", "text": "ToolHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredTool.meta", "type": "Object", "tags": [], "label": "meta", "description": [ "\nOptional set of metadata for this tool." ], "signature": [ "Partial> | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider", "type": "Interface", "tags": [], "label": "RegisteredToolProvider", "description": [ "\nTool provider interface, as registered by API consumers." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.has", "type": "Function", "tags": [], "label": "has", "description": [ "\nCheck if a tool is available in the provider." ], "signature": [ "(options: { toolId: string; request: ", "KibanaRequest", "; }) => Promise" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.has.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.has.$1.toolId", "type": "string", "tags": [], "label": "toolId", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.has.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nRetrieve a tool based on its identifier.\nIf not found,the provider should throw a {@link OnechatToolNotFoundError}" ], "signature": [ "(options: { toolId: string; request: ", "KibanaRequest", "; }) => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RegisteredTool", "text": "RegisteredTool" }, ", unknown>>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.get.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.get.$1.toolId", "type": "string", "tags": [], "label": "toolId", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.get.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList all tools present in the provider." ], "signature": [ "(options: { request: ", "KibanaRequest", "; }) => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RegisteredTool", "text": "RegisteredTool" }, ", unknown>[]>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.list.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolProvider.list.$1.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams", "type": "Interface", "tags": [], "label": "RunAgentParams", "description": [ "\nParams for {@link RunAgentFn}" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentParams", "text": "RunAgentParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams.agentId", "type": "CompoundType", "tags": [], "label": "agentId", "description": [ "\nID of the agent to call." ], "signature": [ "string | ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.StructuredAgentIdentifier", "text": "StructuredAgentIdentifier" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams.agentParams", "type": "Uncategorized", "tags": [], "label": "agentParams", "description": [ "\nParameters to call the agent with." ], "signature": [ "TParams" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams.onEvent", "type": "Function", "tags": [], "label": "onEvent", "description": [ "\nOptional event handler." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams.request", "type": "Object", "tags": [], "label": "request", "description": [ "\nThe request that initiated that run." ], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentParams.defaultConnectorId", "type": "string", "tags": [], "label": "defaultConnectorId", "description": [ "\nOptional genAI connector id to use as default.\nIf unspecified, will use internal logic to use the default connector" ], "signature": [ "string | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentReturn", "type": "Interface", "tags": [], "label": "RunAgentReturn", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentReturn.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "return from the agent" ], "signature": [ "TResult" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentReturn.runId", "type": "string", "tags": [], "label": "runId", "description": [ "ID of this run" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunContext", "type": "Interface", "tags": [], "label": "RunContext", "description": [ "\nContext bound to a run execution.\nContains metadata associated with the run's current state.\nWill be attached to errors thrown during a run." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunContext.runId", "type": "string", "tags": [], "label": "runId", "description": [ "\nThe run identifier, which can be used for tracing" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunContext.stack", "type": "Array", "tags": [], "label": "stack", "description": [ "\nThe current execution stack" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunContextStackEntry", "text": "RunContextStackEntry" }, "[]" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.Runner", "type": "Interface", "tags": [], "label": "Runner", "description": [ "\nPublic onechat runner." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.Runner.runTool", "type": "Function", "tags": [], "label": "runTool", "description": [ "\nExecute a tool." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolParams", "text": "RunToolParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.Runner.runTool.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolParams", "text": "RunToolParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.Runner.runAgent", "type": "Function", "tags": [], "label": "runAgent", "description": [ "\nExecute an agent;" ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentParams", "text": "RunAgentParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.Runner.runAgent.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentParams", "text": "RunAgentParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams", "type": "Interface", "tags": [], "label": "RunToolParams", "description": [ "\nParams for {@link RunToolFn}" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolParams", "text": "RunToolParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams.toolId", "type": "CompoundType", "tags": [], "label": "toolId", "description": [ "\nID of the tool to call." ], "signature": [ "string | ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.StructuredToolIdentifier", "text": "StructuredToolIdentifier" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams.toolParams", "type": "Uncategorized", "tags": [], "label": "toolParams", "description": [ "\nParameters to call the tool with." ], "signature": [ "TParams" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams.onEvent", "type": "Function", "tags": [], "label": "onEvent", "description": [ "\nOptional event handler." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams.request", "type": "Object", "tags": [], "label": "request", "description": [ "\nThe request that initiated that run." ], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolParams.defaultConnectorId", "type": "string", "tags": [], "label": "defaultConnectorId", "description": [ "\nOptional genAI connector id to use as default.\nIf unspecified, will use internal logic to use the default connector\n(EIS if there, otherwise openAI, otherwise any GenAI)" ], "signature": [ "string | undefined" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolReturn", "type": "Interface", "tags": [], "label": "RunToolReturn", "description": [ "\nReturn type for tool invocation APIs.\n\nWrapping the plain result to allow extending the shape later without\nintroducing breaking changes." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolReturn.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "\nThe result value as returned by the tool." ], "signature": [ "TResult" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolReturn.runId", "type": "string", "tags": [], "label": "runId", "description": [ "\nID of this run" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedModel", "type": "Interface", "tags": [], "label": "ScopedModel", "description": [ "\nRepresents a model that can be used within the onechat framework (e.g. tools).\n\nIt exposes different interfaces to models." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedModel.chatModel", "type": "Object", "tags": [], "label": "chatModel", "description": [ "\nlangchain chat model." ], "signature": [ { "pluginId": "@kbn/inference-langchain", "scope": "common", "docId": "kibKbnInferenceLangchainPluginApi", "section": "def-common.InferenceChatModel", "text": "InferenceChatModel" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedModel.inferenceClient", "type": "Object", "tags": [], "label": "inferenceClient", "description": [ "\nInference client." ], "signature": [ { "pluginId": "@kbn/inference-common", "scope": "common", "docId": "kibKbnInferenceCommonPluginApi", "section": "def-common.BoundInferenceClient", "text": "BoundInferenceClient" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/model_provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunner", "type": "Interface", "tags": [], "label": "ScopedRunner", "description": [ "\nRepresents a runner, which is the entry point to execute all onechat primitives,\nsuch as tools or agents.\n\nThis version is pre-scoped to a given request, meaning APIs don't need to be passed\ndown a request object." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunner.runTool", "type": "Function", "tags": [], "label": "runTool", "description": [ "\nExecute a tool." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunnerRunToolsParams", "text": "ScopedRunnerRunToolsParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunner.runTool.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ToolIdentifier", "text": "ToolIdentifier" }, "; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunner.runAgent", "type": "Function", "tags": [], "label": "runAgent", "description": [ "\nExecute an agent" ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunnerRunAgentParams", "text": "ScopedRunnerRunAgentParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunner.runAgent.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; agentId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentIdentifier", "text": "AgentIdentifier" }, "; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventEmitter", "type": "Interface", "tags": [], "label": "ToolEventEmitter", "description": [], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventEmitter.emit", "type": "Function", "tags": [], "label": "emit", "description": [], "signature": [ "(event: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.InternalToolEvent", "text": "InternalToolEvent" }, ">) => void" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventEmitter.emit.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.OnechatEvent", "text": "OnechatEvent" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext", "type": "Interface", "tags": [], "label": "ToolHandlerContext", "description": [ "\nScoped context which can be used during tool execution to access\na panel of built-in services, such as a pre-scoped elasticsearch client." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.request", "type": "Object", "tags": [], "label": "request", "description": [ "\nThe request that was provided when initiating that tool execution.\nCan be used to create scoped services not directly exposed by this context." ], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [ "\nA cluster client scoped to the current user.\nCan be used to access ES on behalf of either the current user or the system user." ], "signature": [ "IScopedClusterClient" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.modelProvider", "type": "Object", "tags": [], "label": "modelProvider", "description": [ "\nInference model provider scoped to the current user.\nCan be used to access the inference APIs or chatModel." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ModelProvider", "text": "ModelProvider" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.toolProvider", "type": "Object", "tags": [], "label": "toolProvider", "description": [ "\nTool provider that can be used to list or execute tools." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProvider", "text": "ToolProvider" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.runner", "type": "Object", "tags": [], "label": "runner", "description": [ "\nOnechat runner scoped to the current execution.\nCan be used to run other workchat primitive as part of the tool execution." ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunner", "text": "ScopedRunner" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.events", "type": "Object", "tags": [], "label": "events", "description": [ "\nEvent emitter that can be used to emits custom events" ], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventEmitter", "text": "ToolEventEmitter" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerContext.logger", "type": "Object", "tags": [], "label": "logger", "description": [ "\nLogger scoped to this execution" ], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.Logger", "text": "Logger" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider", "type": "Interface", "tags": [], "label": "ToolProvider", "description": [ "\nCommon interface shared across all tool providers." ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.has", "type": "Function", "tags": [], "label": "has", "description": [ "\nCheck if a tool is available in the provider" ], "signature": [ "(options: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderHasOptions", "text": "ToolProviderHasOptions" }, ") => Promise" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.has.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderHasOptions", "text": "ToolProviderHasOptions" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nRetrieve a tool based on its identifier.\nIf not found, will throw a toolNotFound error." ], "signature": [ "(options: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderGetOptions", "text": "ToolProviderGetOptions" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableTool", "text": "ExecutableTool" }, ", unknown>>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.get.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderGetOptions", "text": "ToolProviderGetOptions" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList all tools based on the provided filters" ], "signature": [ "(options: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderListOptions", "text": "ToolProviderListOptions" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableTool", "text": "ExecutableTool" }, ", unknown>[]>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProvider.list.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolProviderListOptions", "text": "ToolProviderListOptions" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderGetOptions", "type": "Interface", "tags": [], "label": "ToolProviderGetOptions", "description": [ "\nOptions for {@link ToolProvider.get}" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderGetOptions.toolId", "type": "CompoundType", "tags": [], "label": "toolId", "description": [], "signature": [ "string | ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.StructuredToolIdentifier", "text": "StructuredToolIdentifier" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderGetOptions.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderHasOptions", "type": "Interface", "tags": [], "label": "ToolProviderHasOptions", "description": [ "\nOptions for {@link ToolProvider.has}" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderHasOptions.toolId", "type": "CompoundType", "tags": [], "label": "toolId", "description": [], "signature": [ "string | ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.StructuredToolIdentifier", "text": "StructuredToolIdentifier" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderHasOptions.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderListOptions", "type": "Interface", "tags": [], "label": "ToolProviderListOptions", "description": [ "\nOptions for {@link ToolProvider.list}" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolProviderListOptions.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentDefinition", "type": "Type", "tags": [], "label": "AgentDefinition", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentDefinition", "text": "ConversationalAgentDefinition" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerFn", "type": "Type", "tags": [], "label": "AgentHandlerFn", "description": [], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, ", context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerReturn", "text": "AgentHandlerReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentHandlerFn.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.AgentRegistry", "type": "Type", "tags": [], "label": "AgentRegistry", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentProvider", "text": "AgentProvider" }, "<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableConversationalAgent", "text": "ExecutableConversationalAgent" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentHandlerFn", "type": "Type", "tags": [], "label": "ConversationalAgentHandlerFn", "description": [ "\nConversational agent handler" ], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentParams", "text": "ConversationalAgentParams" }, ">, context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerReturn", "text": "AgentHandlerReturn" }, "<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentResponse", "text": "ConversationalAgentResponse" }, ">>" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentHandlerFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerParams", "text": "AgentHandlerParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ConversationalAgentHandlerFn.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.AgentHandlerContext", "text": "AgentHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/provider.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgent", "type": "Type", "tags": [], "label": "ExecutableAgent", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableAgentBase", "text": "ExecutableAgentBase" }, "<", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentType", "text": "AgentType" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentParams", "text": "ConversationalAgentParams" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentResponse", "text": "ConversationalAgentResponse" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentHandlerFn", "type": "Type", "tags": [], "label": "ExecutableAgentHandlerFn", "description": [], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableAgentHandlerParams", "text": "ExecutableAgentHandlerParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentHandlerFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableAgentHandlerParams", "type": "Type", "tags": [], "label": "ExecutableAgentHandlerParams", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableConversationalAgent", "type": "Type", "tags": [], "label": "ExecutableConversationalAgent", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableAgentBase", "text": "ExecutableAgentBase" }, "<", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentType", "text": "AgentType" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentParams", "text": "ConversationalAgentParams" }, ", ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ConversationalAgentResponse", "text": "ConversationalAgentResponse" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableToolHandlerFn", "type": "Type", "tags": [], "label": "ExecutableToolHandlerFn", "description": [ "\nExecution handler for {@link ExecutableTool}" ], "signature": [ "(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ExecutableToolHandlerParams", "text": "ExecutableToolHandlerParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableToolHandlerFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ExecutableToolHandlerParams", "type": "Type", "tags": [], "label": "ExecutableToolHandlerParams", "description": [ "\nParam type for {@link ExecutableToolHandlerFn}" ], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.InternalToolEvent", "type": "Type", "tags": [], "label": "InternalToolEvent", "description": [ "\nInternal-facing events, as emitted by tool or agent owners." ], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.OnechatEvent", "text": "OnechatEvent" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.OnechatToolEvent", "type": "Type", "tags": [], "label": "OnechatToolEvent", "description": [ "\nPublic-facing events, as received by the API consumer." ], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.OnechatEvent", "text": "OnechatEvent" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RegisteredToolMeta", "type": "Type", "tags": [], "label": "RegisteredToolMeta", "description": [ "\nSubset of {@link ToolDescriptorMeta} that can be defined during tool registration." ], "signature": [ "{ tags?: string[] | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentFn", "type": "Type", "tags": [], "label": "RunAgentFn", "description": [ "\nPublic onechat API to execute a tools." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentParams", "text": "RunAgentParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentParams", "text": "RunAgentParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentOnEventFn", "type": "Type", "tags": [], "label": "RunAgentOnEventFn", "description": [], "signature": [ "(event: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ChatAgentEvent", "text": "ChatAgentEvent" }, ") => void" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunAgentOnEventFn.$1", "type": "CompoundType", "tags": [], "label": "event", "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-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunContextStackEntry", "type": "Type", "tags": [], "label": "RunContextStackEntry", "description": [ "\nRepresents an element in the run context's stack.\nUsed to follow nested / chained execution." ], "signature": [ "{ type: \"tool\"; toolId: `${string}::${string}`; } | { type: \"agent\"; agentId: `${string}::${string}`; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolFn", "type": "Type", "tags": [], "label": "RunToolFn", "description": [ "\nPublic onechat API to execute a tools." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolParams", "text": "RunToolParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.RunToolFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolParams", "text": "RunToolParams" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunAgentFn", "type": "Type", "tags": [], "label": "ScopedRunAgentFn", "description": [ "\nPublic onechat API to execute a tools." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunnerRunAgentParams", "text": "ScopedRunnerRunAgentParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentReturn", "text": "RunAgentReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunAgentFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; agentId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentIdentifier", "text": "AgentIdentifier" }, "; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunnerRunAgentParams", "type": "Type", "tags": [], "label": "ScopedRunnerRunAgentParams", "description": [ "\nParams for {@link ScopedRunner.runTool}" ], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunAgentOnEventFn", "text": "RunAgentOnEventFn" }, " | undefined; agentId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.AgentIdentifier", "text": "AgentIdentifier" }, "; defaultConnectorId?: string | undefined; agentParams: TParams; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/agents/runner.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunnerRunToolsParams", "type": "Type", "tags": [], "label": "ScopedRunnerRunToolsParams", "description": [ "\nParams for {@link ScopedRunner.runTool}" ], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ToolIdentifier", "text": "ToolIdentifier" }, "; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunToolFn", "type": "Type", "tags": [], "label": "ScopedRunToolFn", "description": [ "\nPublic onechat API to execute a tools." ], "signature": [ ", TResult = unknown>(params: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ScopedRunnerRunToolsParams", "text": "ScopedRunnerRunToolsParams" }, ") => Promise<", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.RunToolReturn", "text": "RunToolReturn" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ScopedRunToolFn.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ onEvent?: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolEventHandlerFn", "text": "ToolEventHandlerFn" }, " | undefined; toolId: ", { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.ToolIdentifier", "text": "ToolIdentifier" }, "; toolParams: TParams; defaultConnectorId?: string | undefined; }" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/runner.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventEmitterFn", "type": "Type", "tags": [], "label": "ToolEventEmitterFn", "description": [ "\nEvent emitter function, exposed from tool or agent runnable context." ], "signature": [ "(event: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.InternalToolEvent", "text": "InternalToolEvent" }, ">) => void" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventEmitterFn.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.OnechatEvent", "text": "OnechatEvent" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventHandlerFn", "type": "Type", "tags": [], "label": "ToolEventHandlerFn", "description": [ "\nEvent handler function to listen to run events during execution of tools, agents or other onechat primitives." ], "signature": [ "(event: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.OnechatToolEvent", "text": "OnechatToolEvent" }, ">) => void" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolEventHandlerFn.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "@kbn/onechat-common", "scope": "common", "docId": "kibKbnOnechatCommonPluginApi", "section": "def-common.OnechatEvent", "text": "OnechatEvent" }, ">" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/events.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerFn", "type": "Type", "tags": [], "label": "ToolHandlerFn", "description": [ "\nTool handler function for {@link RegisteredTool} handlers." ], "signature": [ "(args: TParams, context: ", { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolHandlerContext", "text": "ToolHandlerContext" }, ") => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerFn.$1", "type": "Uncategorized", "tags": [], "label": "args", "description": [], "signature": [ "TParams" ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/onechat-server", "id": "def-common.ToolHandlerFn.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/onechat-server", "scope": "common", "docId": "kibKbnOnechatServerPluginApi", "section": "def-common.ToolHandlerContext", "text": "ToolHandlerContext" } ], "path": "x-pack/platform/packages/shared/onechat/onechat-server/src/tools.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "objects": [] } }