mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
2694 lines
No EOL
110 KiB
JSON
2694 lines
No EOL
110 KiB
JSON
{
|
|
"id": "@kbn/elastic-assistant",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AlertsRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AlertsRange",
|
|
"description": [],
|
|
"signature": [
|
|
"React.FunctionComponent<Props>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/knowledge_base/alerts_range.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AlertsRange.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AlertsRange.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.analyzeMarkdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "analyzeMarkdown",
|
|
"description": [
|
|
"\n`analyzeMarkdown` is a helper that enriches content returned from a query\nwith action buttons\n\nReturns a list of code block details for each code block in the markdown,\nincluding the type of code block and the content of the code block.\n"
|
|
],
|
|
"signature": [
|
|
"(markdown: string) => ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.CodeBlockDetails",
|
|
"text": "CodeBlockDetails"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.analyzeMarkdown.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "markdown",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Assistant",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Assistant",
|
|
"description": [],
|
|
"signature": [
|
|
"React.NamedExoticComponent<",
|
|
"Props",
|
|
">"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Assistant.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantOverlay",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AssistantOverlay",
|
|
"description": [],
|
|
"signature": [
|
|
"React.NamedExoticComponent<unknown> & { readonly type: () => React.JSX.Element | null; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantOverlay.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AssistantProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({ actionTypeRegistry, alertsIndexPattern, assistantAvailability, assistantTelemetry, augmentMessageCodeBlocks, docLinks, basePath, basePromptContexts, children, getComments, http, inferenceEnabled, navigateToApp, nameSpace, productDocBase, title, toasts, currentAppId, userProfileService, chrome, }: ",
|
|
"AssistantProviderProps",
|
|
") => React.JSX.Element"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n actionTypeRegistry,\n alertsIndexPattern,\n assistantAvailability,\n assistantTelemetry,\n augmentMessageCodeBlocks,\n docLinks,\n basePath,\n basePromptContexts = [],\n children,\n getComments,\n http,\n inferenceEnabled = false,\n navigateToApp,\n nameSpace = DEFAULT_ASSISTANT_NAMESPACE,\n productDocBase,\n title = DEFAULT_ASSISTANT_TITLE,\n toasts,\n currentAppId,\n userProfileService,\n chrome,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"AssistantProviderProps"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantSpaceIdProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "AssistantSpaceIdProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"({ children, spaceId }: SpaceIdProviderProps) => React.JSX.Element"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_space_id.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantSpaceIdProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ children, spaceId }",
|
|
"description": [],
|
|
"signature": [
|
|
"SpaceIdProviderProps"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_space_id.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdateConversations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkUpdateConversations",
|
|
"description": [],
|
|
"signature": [
|
|
"(http: ",
|
|
"HttpSetup",
|
|
", conversationsActions: ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ConversationsBulkActions",
|
|
"text": "ConversationsBulkActions"
|
|
},
|
|
", toasts?: ",
|
|
"IToasts",
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.BulkActionResponse",
|
|
"text": "BulkActionResponse"
|
|
},
|
|
" | undefined>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdateConversations.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdateConversations.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "conversationsActions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ConversationsBulkActions",
|
|
"text": "ConversationsBulkActions"
|
|
}
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdateConversations.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"IToasts",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdatePrompts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkUpdatePrompts",
|
|
"description": [],
|
|
"signature": [
|
|
"(http: ",
|
|
"HttpSetup",
|
|
", prompts: { create?: { name: string; content: string; promptType: \"system\" | \"quick\"; consumer?: string | undefined; color?: string | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[] | undefined; update?: { id: string; consumer?: string | undefined; content?: string | undefined; color?: string | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[] | undefined; delete?: { ids?: string[] | undefined; query?: string | undefined; } | undefined; }, toasts?: ",
|
|
"IToasts",
|
|
" | undefined) => Promise<{ attributes: { results: { created: { id: string; name: string; content: string; promptType: \"system\" | \"quick\"; namespace?: string | undefined; consumer?: string | undefined; timestamp?: string | undefined; color?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; users?: { id?: string | undefined; name?: string | undefined; }[] | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[]; updated: { id: string; name: string; content: string; promptType: \"system\" | \"quick\"; namespace?: string | undefined; consumer?: string | undefined; timestamp?: string | undefined; color?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; users?: { id?: string | undefined; name?: string | undefined; }[] | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[]; skipped: { id: string; skip_reason: \"PROMPT_FIELD_NOT_MODIFIED\"; name?: string | undefined; }[]; deleted: string[]; }; summary: { total: number; succeeded: number; failed: number; skipped: number; }; errors?: { message: string; status_code: number; prompts: { id: string; name?: string | undefined; }[]; err_code?: string | undefined; }[] | undefined; }; message?: string | undefined; success?: boolean | undefined; status_code?: number | undefined; prompts_count?: number | undefined; } | { success: false; }>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/bulk_update_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdatePrompts.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/bulk_update_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdatePrompts.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "prompts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create?: { name: string; content: string; promptType: \"system\" | \"quick\"; consumer?: string | undefined; color?: string | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[] | undefined; update?: { id: string; consumer?: string | undefined; content?: string | undefined; color?: string | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[] | undefined; delete?: { ids?: string[] | undefined; query?: string | undefined; } | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/bulk_update_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.bulkUpdatePrompts.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"IToasts",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/bulk_update_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConnectorSelectorInline",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ConnectorSelectorInline",
|
|
"description": [
|
|
"\nA compact wrapper of the ConnectorSelector component used in the Settings modal."
|
|
],
|
|
"signature": [
|
|
"React.FunctionComponent<Props>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/connectorland/connector_selector_inline/connector_selector_inline.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConnectorSelectorInline.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConnectorSelectorInline.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getConversationById",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConversationById",
|
|
"description": [
|
|
"\nAPI call for getting conversation by id.\n"
|
|
],
|
|
"signature": [
|
|
"({ http, id, signal, toasts, }: ",
|
|
"GetConversationByIdParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
" | undefined>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getConversationById.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n http,\n id,\n signal,\n toasts,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"GetConversationByIdParams"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getPrompts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPrompts",
|
|
"description": [],
|
|
"signature": [
|
|
"({ http, signal, toasts, }: { http: ",
|
|
"HttpSetup",
|
|
"; toasts: ",
|
|
"IToasts",
|
|
"; signal?: AbortSignal | undefined; }) => Promise<{ page: number; data: { id: string; name: string; content: string; promptType: \"system\" | \"quick\"; namespace?: string | undefined; consumer?: string | undefined; timestamp?: string | undefined; color?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; users?: { id?: string | undefined; name?: string | undefined; }[] | undefined; categories?: string[] | undefined; isDefault?: boolean | undefined; isNewConversationDefault?: boolean | undefined; }[]; perPage: number; total: number; }>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/use_fetch_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getPrompts.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n http,\n signal,\n toasts,\n}",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/use_fetch_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getPrompts.$1.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/use_fetch_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getPrompts.$1.toasts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"IToasts"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/use_fetch_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getPrompts.$1.signal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/prompts/use_fetch_prompts.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getUserConversationsExist",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUserConversationsExist",
|
|
"description": [
|
|
"\nAPI call for determining whether any user conversations exist\n"
|
|
],
|
|
"signature": [
|
|
"({ http, signal, toasts, }: { http: ",
|
|
"HttpSetup",
|
|
"; toasts?: ",
|
|
"IToasts",
|
|
" | undefined; signal?: AbortSignal | undefined; }) => Promise<boolean>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getUserConversationsExist.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n http,\n signal,\n toasts,\n}",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getUserConversationsExist.$1.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getUserConversationsExist.$1.toasts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"IToasts",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.getUserConversationsExist.$1.signal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.NewChat",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "NewChat",
|
|
"description": [
|
|
"\n`NewChat` displays a _New chat_ icon button, providing all the context\nnecessary to start a new chat. You may optionally style the button icon,\nor override the default _New chat_ text with custom content, like `🪄✨`\n\nUSE THIS WHEN: All the data necessary to start a new chat is available\nin the same part of the React tree as the _New chat_ button."
|
|
],
|
|
"signature": [
|
|
"React.NamedExoticComponent<",
|
|
"Props",
|
|
">"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/new_chat/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.NewChat.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.NewChatByTitle",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "NewChatByTitle",
|
|
"description": [
|
|
"\n`NewChatByTitle` displays a _New chat_ icon button by providing only the `promptContextId`\nof a context that was (already) registered by the `useAssistantOverlay` hook. You may\noptionally style the button icon, or override the default _New chat_ text with custom\ncontent, like {'🪄✨'}\n\nUSE THIS WHEN: all the data necessary to start a new chat is NOT available\nin the same part of the React tree as the _New chat_ button. When paired\nwith the `useAssistantOverlay` hook, this option enables context to be be\nregistered where the data is available, and then the _New chat_ button can be displayed\nin another part of the tree."
|
|
],
|
|
"signature": [
|
|
"React.NamedExoticComponent<",
|
|
"Props",
|
|
">"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/new_chat_by_title/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.NewChatByTitle.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.UpgradeButtons",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UpgradeButtons",
|
|
"description": [],
|
|
"signature": [
|
|
"React.NamedExoticComponent<{ basePath: string; }> & { readonly type: ({ basePath }: { basePath: string; }) => React.JSX.Element; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/upgrade/upgrade_buttons.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.UpgradeButtons.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useAssistantContext",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"UseAssistantContext"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantLastConversation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useAssistantLastConversation",
|
|
"description": [],
|
|
"signature": [
|
|
"({ nameSpace, spaceId, }: { nameSpace?: string | undefined; spaceId: string; }) => { getLastConversation: (selectedConversation?: ",
|
|
"SelectedConversation",
|
|
" | undefined) => ",
|
|
"LastConversation",
|
|
"; setLastConversation: (lastConversation: ",
|
|
"LastConversation",
|
|
") => void; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_last_conversation.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantLastConversation.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n nameSpace = DEFAULT_ASSISTANT_NAMESPACE,\n spaceId,\n}",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_last_conversation.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantLastConversation.$1.nameSpace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "nameSpace",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_last_conversation.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantLastConversation.$1.spaceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_space_aware_context/use_last_conversation.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useAssistantOverlay",
|
|
"description": [
|
|
"\n`useAssistantOverlay` is a hook that registers context with the assistant overlay, and\nreturns an optional `showAssistantOverlay` function to display the assistant overlay.\nAs an alterative to using the `showAssistantOverlay` returned from this hook, you may\nuse the `NewChatByTitle` component and pass it the `promptContextId` returned by this hook.\n\nUSE THIS WHEN: You want to register context in one part of the tree, and then show\na _New chat_ button in another part of the tree without passing around the data, or when\nyou want to build a custom `New chat` button with features not not provided by the\n`NewChat` component."
|
|
],
|
|
"signature": [
|
|
"(category: string, conversationTitle: string | null, description: string, getPromptContext: () => Promise<string> | Promise<Record<string, string[]>>, id: string | null, suggestedUserPrompt: string | null | undefined, tooltip: React.ReactNode, isAssistantEnabled: boolean, replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | null | undefined) => UseAssistantOverlay"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "conversationTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$4",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPromptContext",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<string> | Promise<Record<string, string[]>>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$5",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$6",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "suggestedUserPrompt",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$7",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "tooltip",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ReactNode"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$8",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAssistantEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useAssistantOverlay.$9",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "replacements",
|
|
"description": [],
|
|
"signature": [
|
|
"Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | null | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_assistant_overlay/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useFetchCurrentUserConversations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useFetchCurrentUserConversations",
|
|
"description": [
|
|
"\nAPI call for fetching assistant conversations for the current user"
|
|
],
|
|
"signature": [
|
|
"({ http, fields, filter, page, perPage, signal, sortField, sortOrder, refetchOnWindowFocus, isAssistantEnabled, setTotalItemCount, }: ",
|
|
"UseFetchCurrentUserConversationsParams",
|
|
") => ",
|
|
"FetchCurrentUserConversations"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/use_fetch_current_user_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useFetchCurrentUserConversations.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n http,\n fields = query.fields,\n filter,\n page = query.page,\n perPage = query.perPage,\n signal,\n sortField = 'updated_at',\n sortOrder = 'desc',\n refetchOnWindowFocus = true,\n isAssistantEnabled,\n setTotalItemCount,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"UseFetchCurrentUserConversationsParams"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/use_fetch_current_user_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useLoadConnectors",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useLoadConnectors",
|
|
"description": [],
|
|
"signature": [
|
|
"({ http, toasts, inferenceEnabled, }: ",
|
|
"Props",
|
|
") => ",
|
|
"UseQueryResult",
|
|
"<",
|
|
"AIConnector",
|
|
"[], ",
|
|
"IHttpFetchError",
|
|
"<unknown>>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/connectorland/use_load_connectors/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.useLoadConnectors.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n http,\n toasts,\n inferenceEnabled = false,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"Props"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/connectorland/use_load_connectors/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AssistantAvailability",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.isAssistantEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAssistantEnabled",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.hasAssistantPrivilege",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasAssistantPrivilege",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.hasConnectorsAllPrivilege",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasConnectorsAllPrivilege",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.hasConnectorsReadPrivilege",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasConnectorsReadPrivilege",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.hasUpdateAIAssistantAnonymization",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasUpdateAIAssistantAnonymization",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantAvailability.hasManageGlobalKnowledgeBase",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasManageGlobalKnowledgeBase",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AssistantTelemetry",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantInvoked",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportAssistantInvoked",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: { invokedBy: string; }) => void"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantInvoked.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantInvoked.$1.invokedBy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "invokedBy",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportAssistantMessageSent",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: { role: string; actionTypeId: string; model?: string | undefined; provider?: string | undefined; isEnabledKnowledgeBase: boolean; }) => void"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1.role",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "role",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1.model",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "model",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1.provider",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "provider",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantMessageSent.$1.isEnabledKnowledgeBase",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isEnabledKnowledgeBase",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantQuickPrompt",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportAssistantQuickPrompt",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: { promptTitle: string; }) => void"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantQuickPrompt.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantQuickPrompt.$1.promptTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "promptTitle",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantSettingToggled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportAssistantSettingToggled",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: { assistantStreamingEnabled?: boolean | undefined; alertsCountUpdated?: boolean | undefined; }) => void"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantSettingToggled.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantSettingToggled.$1.assistantStreamingEnabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "assistantStreamingEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.AssistantTelemetry.reportAssistantSettingToggled.$1.alertsCountUpdated",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alertsCountUpdated",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAggregatedError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionAggregatedError",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAggregatedError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAggregatedError.status_code",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "status_code",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAggregatedError.err_code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "err_code",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAggregatedError.conversations",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "conversations",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; name?: string | undefined; }[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionAttributes",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAttributes.summary",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "summary",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.BulkActionSummary",
|
|
"text": "BulkActionSummary"
|
|
}
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAttributes.results",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "results",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.BulkActionResult",
|
|
"text": "BulkActionResult"
|
|
}
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionAttributes.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.BulkActionAggregatedError",
|
|
"text": "BulkActionAggregatedError"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionResponse",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse.success",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse.conversations_count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "conversations_count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResponse.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.BulkActionAttributes",
|
|
"text": "BulkActionAttributes"
|
|
}
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionResult",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResult.updated",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "updated",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResult.created",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "created",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResult.deleted",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "deleted",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionResult.skipped",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "skipped",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionSummary",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionSummary",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionSummary.failed",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "failed",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionSummary.skipped",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "skipped",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionSummary.succeeded",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "succeeded",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.BulkActionSummary.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ClientMessage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ClientMessage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ClientMessage",
|
|
"text": "ClientMessage"
|
|
},
|
|
" extends Omit<{ timestamp: string; role: \"user\" | \"system\" | \"assistant\"; content: string; metadata?: { contentReferences?: Zod.objectOutputType<{}, Zod.ZodUnion<[Zod.ZodObject<Zod.objectUtil.extendShape<{ id: Zod.ZodString; type: Zod.ZodString; }, { type: Zod.ZodLiteral<\"KnowledgeBaseEntry\">; knowledgeBaseEntryId: Zod.ZodString; knowledgeBaseEntryName: Zod.ZodString; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: \"KnowledgeBaseEntry\"; knowledgeBaseEntryId: string; knowledgeBaseEntryName: string; }, { id: string; type: \"KnowledgeBaseEntry\"; knowledgeBaseEntryId: string; knowledgeBaseEntryName: string; }>, Zod.ZodObject<Zod.objectUtil.extendShape<{ id: Zod.ZodString; type: Zod.ZodString; }, { type: Zod.ZodLiteral<\"SecurityAlert\">; alertId: Zod.ZodString; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: \"SecurityAlert\"; alertId: string; }, { id: string; type: \"SecurityAlert\"; alertId: string; }>, Zod.ZodObject<Zod.objectUtil.extendShape<{ id: Zod.ZodString; type: Zod.ZodString; }, { type: Zod.ZodLiteral<\"SecurityAlertsPage\">; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: \"SecurityAlertsPage\"; }, { id: string; type: \"SecurityAlertsPage\"; }>, Zod.ZodObject<Zod.objectUtil.extendShape<{ id: Zod.ZodString; type: Zod.ZodString; }, { type: Zod.ZodLiteral<\"ProductDocumentation\">; title: Zod.ZodString; url: Zod.ZodString; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: \"ProductDocumentation\"; title: string; url: string; }, { id: string; type: \"ProductDocumentation\"; title: string; url: string; }>, Zod.ZodObject<Zod.objectUtil.extendShape<{ id: Zod.ZodString; type: Zod.ZodString; }, { type: Zod.ZodLiteral<\"EsqlQuery\">; query: Zod.ZodString; label: Zod.ZodString; timerange: Zod.ZodOptional<Zod.ZodObject<{ from: Zod.ZodString; to: Zod.ZodString; }, \"strip\", Zod.ZodTypeAny, { from: string; to: string; }, { from: string; to: string; }>>; }>, \"strip\", Zod.ZodTypeAny, { id: string; type: \"EsqlQuery\"; label: string; query: string; timerange?: { from: string; to: string; } | undefined; }, { id: string; type: \"EsqlQuery\"; label: string; query: string; timerange?: { from: string; to: string; } | undefined; }>]>, \"strip\"> | undefined; } | undefined; isError?: boolean | undefined; reader?: Zod.objectOutputType<{}, Zod.ZodUnknown, \"strip\"> | undefined; traceData?: { transactionId?: string | undefined; traceId?: string | undefined; } | undefined; }, \"content\" | \"reader\">"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ClientMessage.reader",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "reader",
|
|
"description": [],
|
|
"signature": [
|
|
"ReadableStreamDefaultReader<Uint8Array> | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ClientMessage.content",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "content",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ClientMessage.presentation",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "presentation",
|
|
"description": [],
|
|
"signature": [
|
|
"MessagePresentation",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CodeBlockDetails",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"eql\" | \"esql\" | \"sql\" | \"kql\" | \"dsl\" | \"json\" | \"no-type\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.content",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "content",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.start",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.end",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "end",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.getControlContainer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getControlContainer",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Element | undefined) | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.CodeBlockDetails.button",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "button",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Conversation",
|
|
"description": [
|
|
"\nComplete state to reconstruct a conversation instance.\nIncludes all messages, connector configured, and relevant UI state.\n"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'@timestamp'",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.apiConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apiConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; actionTypeId: string; provider?: \"Other\" | \"OpenAI\" | \"Azure OpenAI\" | undefined; model?: string | undefined; defaultSystemPromptId?: string | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.user",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id?: string | undefined; name?: string | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.messages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "messages",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ClientMessage",
|
|
"text": "ClientMessage"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.updatedAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.createdAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.replacements",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "replacements",
|
|
"description": [],
|
|
"signature": [
|
|
"{} & { [k: string]: string; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.Conversation.excludeFromLastConversationStorage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "excludeFromLastConversationStorage",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationsBulkActions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConversationsBulkActions",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationsBulkActions.update",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "update",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ConversationUpdateParams",
|
|
"text": "ConversationUpdateParams"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationsBulkActions.create",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationsBulkActions.delete",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ids: string[]; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationUpdateParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConversationUpdateParams",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationUpdateParams.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationUpdateParams.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationUpdateParams.messages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "messages",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.ClientMessage",
|
|
"text": "ClientMessage"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ConversationUpdateParams.apiConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apiConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; actionTypeId: string; provider?: \"Other\" | \"OpenAI\" | \"Azure OpenAI\" | undefined; model?: string | undefined; defaultSystemPromptId?: string | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/api/conversations/bulk_update_actions_conversations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PromptContext",
|
|
"description": [
|
|
"\nThis interface is used to pass context to the Elastic AI Assistant,\nfor the purpose of building prompts. Examples of context include:\n- a single alert\n- multiple alerts\n- a single event\n- multiple events\n- markdown\n- csv\n- anything else that the LLM can interpret"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [
|
|
"\nThe category of data, e.g. `alert | alerts | event | events | string`\n\n`category` helps the Elastic AI Assistant display the most relevant user prompts"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nThe Elastic AI Assistant will display this **short**, static description\nin the context pill"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.getPromptContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPromptContext",
|
|
"description": [
|
|
"\nThe Elastic AI Assistant will invoke this function to retrieve the context data,\nwhich will be included in a prompt (e.g. the contents of an alert or an event)"
|
|
],
|
|
"signature": [
|
|
"() => Promise<string> | Promise<Record<string, string[]>>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nA unique identifier for this prompt context"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.replacements",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "replacements",
|
|
"description": [
|
|
"\nReplacements associated with the context, i.e. replacements for an attack discovery provided as context"
|
|
],
|
|
"signature": [
|
|
"Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.suggestedUserPrompt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "suggestedUserPrompt",
|
|
"description": [
|
|
"\nAn optional user prompt that's filled in, but not sent, when the Elastic AI Assistant opens"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContext.tooltip",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "tooltip",
|
|
"description": [
|
|
"\nThe Elastic AI Assistant will display this tooltip when the user hovers over the context pill"
|
|
],
|
|
"signature": [
|
|
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.ATTACK_DISCOVERY_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ATTACK_DISCOVERY_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"attackDiscovery\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.DEFAULT_ASSISTANT_NAMESPACE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DEFAULT_ASSISTANT_NAMESPACE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"elasticAssistantDefault\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.DEFAULT_ATTACK_DISCOVERY_MAX_ALERTS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_ATTACK_DISCOVERY_MAX_ALERTS",
|
|
"description": [
|
|
"The default maximum number of alerts to be sent as context when generating Attack discoveries"
|
|
],
|
|
"signature": [
|
|
"100"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.DEFAULT_LATEST_ALERTS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_LATEST_ALERTS",
|
|
"description": [
|
|
"The default `n` latest alerts, ordered by risk score, sent as context to the assistant"
|
|
],
|
|
"signature": [
|
|
"100"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.DEFEND_INSIGHTS_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DEFEND_INSIGHTS_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"defendInsights\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.END_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "END_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"end\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.FILTERS_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FILTERS_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"filters\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.GetAssistantMessages",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAssistantMessages",
|
|
"description": [],
|
|
"signature": [
|
|
"(commentArgs: { abortStream: () => void; currentConversation?: ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
" | undefined; isFetchingResponse: boolean; refetchCurrentConversation: ({ isStreamRefetch }: { isStreamRefetch?: boolean | undefined; }) => void; regenerateMessage: (conversationId: string) => void; showAnonymizedValues: boolean; currentUserAvatar?: ",
|
|
"UserAvatar",
|
|
" | undefined; setIsStreaming: (isStreaming: boolean) => void; systemPromptContent?: string | undefined; contentReferencesVisible: boolean; }) => ",
|
|
"EuiCommentProps",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.GetAssistantMessages.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "commentArgs",
|
|
"description": [],
|
|
"signature": [
|
|
"{ abortStream: () => void; currentConversation?: ",
|
|
{
|
|
"pluginId": "@kbn/elastic-assistant",
|
|
"scope": "public",
|
|
"docId": "kibKbnElasticAssistantPluginApi",
|
|
"section": "def-public.Conversation",
|
|
"text": "Conversation"
|
|
},
|
|
" | undefined; isFetchingResponse: boolean; refetchCurrentConversation: ({ isStreamRefetch }: { isStreamRefetch?: boolean | undefined; }) => void; regenerateMessage: (conversationId: string) => void; showAnonymizedValues: boolean; currentUserAvatar?: ",
|
|
"UserAvatar",
|
|
" | undefined; setIsStreaming: (isStreaming: boolean) => void; systemPromptContent?: string | undefined; contentReferencesVisible: boolean; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/types.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.KNOWLEDGE_BASE_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KNOWLEDGE_BASE_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"knowledgeBase\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.MAX_ALERTS_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAX_ALERTS_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"maxAlerts\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.PromptContextTemplate",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PromptContextTemplate",
|
|
"description": [
|
|
"\nThis interface is used to pass a default or base set of contexts to the Elastic AI Assistant when\ninitializing it. This is used to provide 'category' options when users create Quick Prompts.\nAlso, useful for collating all of a solutions' prompts in one place.\n\ne.g. see Security Solution's x-pack/solutions/security/plugins/security_solution/public/assistant/prompt_contexts/index.tsx"
|
|
],
|
|
"signature": [
|
|
"{ description: string; category: string; tooltip: React.ReactNode; replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined; suggestedUserPrompt?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.QUERY_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "QUERY_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"query\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.QueryType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "QueryType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"eql\" | \"esql\" | \"sql\" | \"kql\" | \"dsl\" | \"json\" | \"no-type\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.SELECT_FEWER_ALERTS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SELECT_FEWER_ALERTS",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/knowledge_base/translations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.SHOW_SETTINGS_TOUR_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SHOW_SETTINGS_TOUR_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"showSettingsTour\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.SingleRangeChangeEvent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SingleRangeChangeEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLButtonElement, MouseEvent>"
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/knowledge_base/alerts_range.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.START_LOCAL_STORAGE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "START_LOCAL_STORAGE_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"start\""
|
|
],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant_context/constants.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/elastic-assistant",
|
|
"id": "def-public.YOUR_ANONYMIZATION_SETTINGS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "YOUR_ANONYMIZATION_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/platform/packages/shared/kbn-elastic-assistant/impl/knowledge_base/translations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |