{ "id": "observabilityAIAssistant", "client": { "classes": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable", "type": "Class", "tags": [], "label": "ShortIdTable", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable.take", "type": "Function", "tags": [], "label": "take", "description": [], "signature": [ "(originalId: string) => string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable.take.$1", "type": "string", "tags": [], "label": "originalId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable.lookup", "type": "Function", "tags": [], "label": "lookup", "description": [], "signature": [ "(shortId: string) => string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ShortIdTable.lookup.$1", "type": "string", "tags": [], "label": "shortId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls", "type": "Function", "tags": [], "label": "ChatItemControls", "description": [], "signature": [ "({\n error,\n loading,\n canRegenerate,\n canGiveFeedback,\n onFeedbackClick,\n onRegenerateClick,\n onStopGeneratingClick,\n}: { error: any; loading: boolean; canRegenerate: boolean; canGiveFeedback: boolean; onFeedbackClick: (feedback: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.Feedback", "text": "Feedback" }, ") => void; onRegenerateClick: () => void; onStopGeneratingClick: () => void; }) => React.JSX.Element | null" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1", "type": "Object", "tags": [], "label": "{\n error,\n loading,\n canRegenerate,\n canGiveFeedback,\n onFeedbackClick,\n onRegenerateClick,\n onStopGeneratingClick,\n}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.error", "type": "Any", "tags": [], "label": "error", "description": [], "signature": [ "any" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.loading", "type": "boolean", "tags": [], "label": "loading", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.canRegenerate", "type": "boolean", "tags": [], "label": "canRegenerate", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.canGiveFeedback", "type": "boolean", "tags": [], "label": "canGiveFeedback", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.onFeedbackClick", "type": "Function", "tags": [], "label": "onFeedbackClick", "description": [], "signature": [ "(feedback: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.Feedback", "text": "Feedback" }, ") => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.onFeedbackClick.$1", "type": "CompoundType", "tags": [], "label": "feedback", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.Feedback", "text": "Feedback" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.onRegenerateClick", "type": "Function", "tags": [], "label": "onRegenerateClick", "description": [], "signature": [ "() => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatItemControls.$1.onStopGeneratingClick", "type": "Function", "tags": [], "label": "onStopGeneratingClick", "description": [], "signature": [ "() => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/chat_item_controls.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.concatenateChatCompletionChunks", "type": "Function", "tags": [], "label": "concatenateChatCompletionChunks", "description": [], "signature": [ "() => (source: ", "Observable", "<", "ChatEvent", ">) => ", "Observable", "<", "ConcatenatedMessage", ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/concatenate_chat_completion_chunks.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ConnectorSelectorBase", "type": "Function", "tags": [], "label": "ConnectorSelectorBase", "description": [], "signature": [ "(props: ", "UseGenAIConnectorsResult", ") => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/connector_selector/connector_selector_base.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ConnectorSelectorBase.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "UseGenAIConnectorsResult" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/connector_selector/connector_selector_base.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionRequestMessage", "type": "Function", "tags": [], "label": "createFunctionRequestMessage", "description": [], "signature": [ "({\n name,\n args,\n}: { name: string; args?: Record | undefined; }) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionRequestMessage.$1", "type": "Object", "tags": [], "label": "{\n name,\n args,\n}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionRequestMessage.$1.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionRequestMessage.$1.args", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionResponseMessage", "type": "Function", "tags": [], "label": "createFunctionResponseMessage", "description": [], "signature": [ "({\n name,\n content,\n data,\n}: { name: string; content: unknown; data?: unknown; }) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionResponseMessage.$1", "type": "Object", "tags": [], "label": "{\n name,\n content,\n data,\n}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionResponseMessage.$1.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionResponseMessage.$1.content", "type": "Unknown", "tags": [], "label": "content", "description": [], "signature": [ "unknown" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createFunctionResponseMessage.$1.data", "type": "Unknown", "tags": [], "label": "data", "description": [], "signature": [ "unknown" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createScreenContextAction", "type": "Function", "tags": [], "label": "createScreenContextAction", "description": [], "signature": [ "(definition: TActionDefinition, respond: TRespondFunction) => ", "ScreenContextActionDefinition", ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/utils/create_screen_context_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createScreenContextAction.$1", "type": "Uncategorized", "tags": [], "label": "definition", "description": [], "signature": [ "TActionDefinition" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/utils/create_screen_context_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createScreenContextAction.$2", "type": "Function", "tags": [], "label": "respond", "description": [], "signature": [ "TRespondFunction" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/utils/create_screen_context_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createStorybookChatService", "type": "Function", "tags": [], "label": "createStorybookChatService", "description": [], "signature": [ "() => ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/storybook_mock.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.createStorybookService", "type": "Function", "tags": [], "label": "createStorybookService", "description": [], "signature": [ "() => ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantService", "text": "ObservabilityAIAssistantService" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/storybook_mock.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FailedToLoadResponse", "type": "Function", "tags": [], "label": "FailedToLoadResponse", "description": [], "signature": [ "() => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/message_panel/failed_to_load_response.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FeedbackButtons", "type": "Function", "tags": [], "label": "FeedbackButtons", "description": [], "signature": [ "({ onClickFeedback }: FeedbackButtonsProps) => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/buttons/feedback_buttons.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FeedbackButtons.$1", "type": "Object", "tags": [], "label": "{ onClickFeedback }", "description": [], "signature": [ "FeedbackButtonsProps" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/buttons/feedback_buttons.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.MessageText", "type": "Function", "tags": [], "label": "MessageText", "description": [], "signature": [ "({ loading, content, onActionClick }: Props) => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/message_panel/message_text.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.MessageText.$1", "type": "Object", "tags": [], "label": "{ loading, content, onActionClick }", "description": [], "signature": [ "Props" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/message_panel/message_text.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync", "type": "Function", "tags": [], "label": "useAbortableAsync", "description": [], "signature": [ "(fn: ({}: { signal: AbortSignal; }) => T | Promise, deps: any[], options: { clearValueOnNext?: boolean | undefined; defaultValue?: (() => T) | undefined; } | undefined) => ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.AbortableAsyncState", "text": "AbortableAsyncState" }, "" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "({}: { signal: AbortSignal; }) => T | Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync.$2", "type": "Array", "tags": [], "label": "deps", "description": [], "signature": [ "any[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync.$3.clearValueOnNext", "type": "CompoundType", "tags": [], "label": "clearValueOnNext", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useAbortableAsync.$3.defaultValue", "type": "Function", "tags": [], "label": "defaultValue", "description": [], "signature": [ "(() => T) | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useGenAIConnectorsWithoutContext", "type": "Function", "tags": [], "label": "useGenAIConnectorsWithoutContext", "description": [], "signature": [ "(assistant: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantService", "text": "ObservabilityAIAssistantService" }, ") => ", "UseGenAIConnectorsResult" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_genai_connectors.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.useGenAIConnectorsWithoutContext.$1", "type": "Object", "tags": [], "label": "assistant", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantService", "text": "ObservabilityAIAssistantService" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_genai_connectors.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation", "type": "Interface", "tags": [], "label": "Conversation", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.user", "type": "Object", "tags": [], "label": "user", "description": [], "signature": [ "{ id?: string | undefined; name: string; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.conversation", "type": "Object", "tags": [], "label": "conversation", "description": [], "signature": [ "{ id: string; title: string; last_updated: string; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.systemMessage", "type": "string", "tags": [], "label": "systemMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.labels", "type": "Object", "tags": [], "label": "labels", "description": [], "signature": [ "{ [x: string]: string; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.numeric_labels", "type": "Object", "tags": [], "label": "numeric_labels", "description": [], "signature": [ "{ [x: string]: number; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Conversation.public", "type": "boolean", "tags": [], "label": "public", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.DiscoveredDataset", "type": "Interface", "tags": [], "label": "DiscoveredDataset", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.DiscoveredDataset.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.DiscoveredDataset.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.DiscoveredDataset.indexPatterns", "type": "Array", "tags": [], "label": "indexPatterns", "description": [], "signature": [ "string[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.DiscoveredDataset.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ "unknown[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition", "type": "Interface", "tags": [], "label": "FunctionDefinition", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition.visibility", "type": "CompoundType", "tags": [], "label": "visibility", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionVisibility", "text": "FunctionVisibility" }, " | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition.descriptionForUser", "type": "string", "tags": [], "label": "descriptionForUser", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionDefinition.parameters", "type": "Uncategorized", "tags": [], "label": "parameters", "description": [], "signature": [ "TParameters | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry", "type": "Interface", "tags": [], "label": "KnowledgeBaseEntry", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.text", "type": "string", "tags": [], "label": "text", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.confidence", "type": "CompoundType", "tags": [], "label": "confidence", "description": [], "signature": [ "\"medium\" | \"high\" | \"low\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.is_correction", "type": "boolean", "tags": [], "label": "is_correction", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"user_instruction\" | \"contextual\" | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.public", "type": "boolean", "tags": [], "label": "public", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.labels", "type": "Object", "tags": [], "label": "labels", "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.role", "type": "Enum", "tags": [], "label": "role", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntry.user", "type": "Object", "tags": [], "label": "user", "description": [], "signature": [ "{ name: string; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Message", "type": "Interface", "tags": [], "label": "Message", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Message.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Message.message", "type": "Object", "tags": [], "label": "message", "description": [], "signature": [ "{ content?: string | undefined; name?: string | undefined; role: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, "; function_call?: { name: string; arguments?: string | undefined; trigger: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".Assistant | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".User | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".Elastic; } | undefined; data?: string | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantChatService", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.sendAnalyticsEvent", "type": "Function", "tags": [], "label": "sendAnalyticsEvent", "description": [], "signature": [ "(event: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.TelemetryEventTypeWithPayload", "text": "TelemetryEventTypeWithPayload" }, ") => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.sendAnalyticsEvent.$1", "type": "CompoundType", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.TelemetryEventTypeWithPayload", "text": "TelemetryEventTypeWithPayload" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat", "type": "Function", "tags": [], "label": "chat", "description": [], "signature": [ "(name: string, options: { systemMessage: string; messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; connectorId: string; functions?: Pick<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">, \"name\" | \"description\" | \"parameters\">[] | undefined; functionCall?: string | undefined; signal: AbortSignal; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; }) => ", "Observable", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionChunkEvent", "text": "ChatCompletionChunkEvent" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.systemMessage", "type": "string", "tags": [], "label": "systemMessage", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.functions", "type": "Array", "tags": [], "label": "functions", "description": [], "signature": [ "Pick<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">, \"name\" | \"description\" | \"parameters\">[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.functionCall", "type": "string", "tags": [], "label": "functionCall", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.signal", "type": "Object", "tags": [], "label": "signal", "description": [], "signature": [ "AbortSignal" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.chat.$2.scopes", "type": "Array", "tags": [], "label": "scopes", "description": [], "signature": [ { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete", "type": "Function", "tags": [], "label": "complete", "description": [], "signature": [ "(options: { getScreenContexts: () => ", "ObservabilityAIAssistantScreenContext", "[]; conversationId?: string | undefined; connectorId: string; systemMessage?: string | undefined; messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; persist: boolean; disableFunctions: boolean | { except: string[]; }; signal: AbortSignal; instructions?: ", "AdHocInstruction", "[] | undefined; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; }) => ", "Observable", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventWithoutError", "text": "StreamingChatResponseEventWithoutError" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.getScreenContexts", "type": "Function", "tags": [], "label": "getScreenContexts", "description": [], "signature": [ "() => ", "ObservabilityAIAssistantScreenContext", "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.conversationId", "type": "string", "tags": [], "label": "conversationId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.systemMessage", "type": "string", "tags": [], "label": "systemMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.persist", "type": "boolean", "tags": [], "label": "persist", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.disableFunctions", "type": "CompoundType", "tags": [], "label": "disableFunctions", "description": [], "signature": [ "boolean | { except: string[]; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.signal", "type": "Object", "tags": [], "label": "signal", "description": [], "signature": [ "AbortSignal" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.instructions", "type": "Array", "tags": [], "label": "instructions", "description": [], "signature": [ "AdHocInstruction", "[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.complete.$1.scopes", "type": "Array", "tags": [], "label": "scopes", "description": [], "signature": [ { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(options?: { contexts?: string[] | undefined; filter?: string | undefined; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; } | undefined) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getFunctions.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getFunctions.$1.contexts", "type": "Array", "tags": [], "label": "contexts", "description": [], "signature": [ "string[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getFunctions.$1.filter", "type": "string", "tags": [], "label": "filter", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getFunctions.$1.scopes", "type": "Array", "tags": [], "label": "scopes", "description": [], "signature": [ { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.functions$", "type": "Object", "tags": [], "label": "functions$", "description": [], "signature": [ "BehaviorSubject", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.hasFunction", "type": "Function", "tags": [], "label": "hasFunction", "description": [], "signature": [ "(name: string) => boolean" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.hasFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getSystemMessage", "type": "Function", "tags": [], "label": "getSystemMessage", "description": [], "signature": [ "() => string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.hasRenderFunction", "type": "Function", "tags": [], "label": "hasRenderFunction", "description": [], "signature": [ "(name: string) => boolean" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.hasRenderFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction", "type": "Function", "tags": [], "label": "renderFunction", "description": [], "signature": [ "(name: string, args: string | undefined, response: { data?: string | undefined; content?: string | undefined; }, onActionClick: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" }, ") => React.ReactNode" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$2", "type": "string", "tags": [], "label": "args", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$3", "type": "Object", "tags": [], "label": "response", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$3.data", "type": "string", "tags": [], "label": "data", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$3.content", "type": "string", "tags": [], "label": "content", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.renderFunction.$4", "type": "Function", "tags": [], "label": "onActionClick", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantChatService.getScopes", "type": "Function", "tags": [], "label": "getScopes", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantService", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.callApi", "type": "Function", "tags": [], "label": "callApi", "description": [], "signature": [ "(endpoint: TEndpoint, ...args: MaybeOptionalArgs<", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, "<{ \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ entryId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/save\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/save\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/user_instructions\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { userInstructions: (", "Instruction", " & { public?: boolean | undefined; })[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/import\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/import\", ", "TypeC", "<{ body: ", "TypeC", "<{ entries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/kb/user_instructions\", ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", "; text: ", "StringC", "; public: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/entries\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/entries\", ", "TypeC", "<{ query: ", "TypeC", "<{ query: ", "StringC", "; sortBy: ", "StringC", "; sortDirection: ", "UnionC", "<[", "LiteralC", "<\"asc\">, ", "LiteralC", "<\"desc\">]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/status\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<", "InferenceInferenceEndpointInfo", "> | undefined; model_stats?: { deployment_state?: ", "MlDeploymentAssignmentState", " | undefined; allocation_state?: ", "MlDeploymentAllocationState", " | undefined; allocation_count?: number | undefined; } | undefined; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/reset\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { result: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/setup\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/setup\", ", "PartialC", "<{ query: ", "PartialC", "<{ model_id: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "InferenceInferenceEndpointInfo", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/summarize\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/summarize\", ", "TypeC", "<{ body: ", "TypeC", "<{ title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/recall\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ queries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ text: ", "StringC", "; }>, ", "PartialC", "<{ boost: ", "NumberC", "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", "<", "StringC", ">; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", "RecalledEntry", "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/functions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/functions\", ", "TypeC", "<{ query: ", "PartialC", "<{ scopes: ", "UnionC", "<[", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>, ", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { functionDefinitions: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]; systemMessage: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/connectors\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/connectors\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[], ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ title: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ conversation: ", "Type", "<", "ConversationUpdateRequest", ", ", "ConversationUpdateRequest", ", unknown>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversation\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversation\", ", "TypeC", "<{ body: ", "TypeC", "<{ conversation: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversations\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversations\", ", "PartialC", "<{ body: ", "PartialC", "<{ query: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { conversations: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /api/observability_ai_assistant/chat/complete 2023-10-31\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "PartialC", "<{ body: ", "PartialC", "<{ actions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; }>; query: ", "PartialC", "<{ format: ", "UnionC", "<[", "LiteralC", "<\"default\">, ", "LiteralC", "<\"openai\">]>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/complete\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/complete\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "TypeC", "<{ body: ", "TypeC", "<{ screenContexts: ", "ArrayC", "<", "Type", "<", "ObservabilityAIAssistantScreenContextRequest", ", ", "ObservabilityAIAssistantScreenContextRequest", ", unknown>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/recall\", ", "TypeC", "<{ body: ", "TypeC", "<{ prompt: ", "StringC", "; context: ", "StringC", "; connectorId: ", "StringC", "; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; systemMessage: ", "StringC", "; messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; functions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>, ", "PartialC", "<{ functionCall: ", "StringC", "; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/index_assets\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/index_assets\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; }, TEndpoint> & Omit & { signal: AbortSignal | null; } & ", "HttpFetchOptions", ">) => Promise<", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ReturnOf", "text": "ReturnOf" }, "<{ \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ entryId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/save\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/save\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/user_instructions\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { userInstructions: (", "Instruction", " & { public?: boolean | undefined; })[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/import\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/import\", ", "TypeC", "<{ body: ", "TypeC", "<{ entries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/kb/user_instructions\", ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", "; text: ", "StringC", "; public: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/entries\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/entries\", ", "TypeC", "<{ query: ", "TypeC", "<{ query: ", "StringC", "; sortBy: ", "StringC", "; sortDirection: ", "UnionC", "<[", "LiteralC", "<\"asc\">, ", "LiteralC", "<\"desc\">]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/status\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<", "InferenceInferenceEndpointInfo", "> | undefined; model_stats?: { deployment_state?: ", "MlDeploymentAssignmentState", " | undefined; allocation_state?: ", "MlDeploymentAllocationState", " | undefined; allocation_count?: number | undefined; } | undefined; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/reset\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { result: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/setup\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/setup\", ", "PartialC", "<{ query: ", "PartialC", "<{ model_id: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "InferenceInferenceEndpointInfo", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/summarize\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/summarize\", ", "TypeC", "<{ body: ", "TypeC", "<{ title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/recall\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ queries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ text: ", "StringC", "; }>, ", "PartialC", "<{ boost: ", "NumberC", "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", "<", "StringC", ">; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", "RecalledEntry", "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/functions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/functions\", ", "TypeC", "<{ query: ", "PartialC", "<{ scopes: ", "UnionC", "<[", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>, ", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { functionDefinitions: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]; systemMessage: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/connectors\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/connectors\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[], ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ title: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ conversation: ", "Type", "<", "ConversationUpdateRequest", ", ", "ConversationUpdateRequest", ", unknown>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversation\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversation\", ", "TypeC", "<{ body: ", "TypeC", "<{ conversation: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversations\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversations\", ", "PartialC", "<{ body: ", "PartialC", "<{ query: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { conversations: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /api/observability_ai_assistant/chat/complete 2023-10-31\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "PartialC", "<{ body: ", "PartialC", "<{ actions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; }>; query: ", "PartialC", "<{ format: ", "UnionC", "<[", "LiteralC", "<\"default\">, ", "LiteralC", "<\"openai\">]>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/complete\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/complete\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "TypeC", "<{ body: ", "TypeC", "<{ screenContexts: ", "ArrayC", "<", "Type", "<", "ObservabilityAIAssistantScreenContextRequest", ", ", "ObservabilityAIAssistantScreenContextRequest", ", unknown>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/recall\", ", "TypeC", "<{ body: ", "TypeC", "<{ prompt: ", "StringC", "; context: ", "StringC", "; connectorId: ", "StringC", "; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; systemMessage: ", "StringC", "; messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; functions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>, ", "PartialC", "<{ functionCall: ", "StringC", "; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/index_assets\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/index_assets\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; }, TEndpoint>>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.callApi.$1", "type": "Uncategorized", "tags": [], "label": "endpoint", "description": [], "signature": [ "TEndpoint" ], "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.callApi.$2", "type": "Uncategorized", "tags": [], "label": "args", "description": [], "signature": [ "RequiredKeys", "<", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions & ", "HttpFetchOptions", "> extends never ? [] | [", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions & ", "HttpFetchOptions", "] : [", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions & ", "HttpFetchOptions", "]" ], "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.isEnabled", "type": "Function", "tags": [], "label": "isEnabled", "description": [], "signature": [ "() => boolean" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "({}: { signal: AbortSignal; }) => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.start.$1", "type": "Object", "tags": [], "label": "{}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.start.$1.signal", "type": "Object", "tags": [], "label": "signal", "description": [], "signature": [ "AbortSignal" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(fn: ", "ChatRegistrationRenderFunction", ") => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.register.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "ChatRegistrationRenderFunction" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.setScreenContext", "type": "Function", "tags": [], "label": "setScreenContext", "description": [], "signature": [ "(screenContext: ", "ObservabilityAIAssistantScreenContext", ") => () => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.setScreenContext.$1", "type": "Object", "tags": [], "label": "screenContext", "description": [], "signature": [ "ObservabilityAIAssistantScreenContext" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.getScreenContexts", "type": "Function", "tags": [], "label": "getScreenContexts", "description": [], "signature": [ "() => ", "ObservabilityAIAssistantScreenContext", "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.conversations", "type": "Object", "tags": [], "label": "conversations", "description": [], "signature": [ "ObservabilityAIAssistantConversationService" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.navigate", "type": "Function", "tags": [], "label": "navigate", "description": [], "signature": [ "(callback: () => void) => Promise<", "Observable", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" }, ">>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.navigate.$1", "type": "Function", "tags": [], "label": "callback", "description": [], "signature": [ "() => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.scope$", "type": "Object", "tags": [], "label": "scope$", "description": [], "signature": [ "BehaviorSubject", "<", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.setScopes", "type": "Function", "tags": [], "label": "setScopes", "description": [], "signature": [ "(scope: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]) => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.setScopes.$1", "type": "Array", "tags": [], "label": "scope", "description": [], "signature": [ { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantService.getScopes", "type": "Function", "tags": [], "label": "getScopes", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult", "type": "Interface", "tags": [], "label": "UseChatResult", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.setMessages", "type": "Function", "tags": [], "label": "setMessages", "description": [], "signature": [ "(messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]) => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.setMessages.$1", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.state", "type": "Enum", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatState", "text": "ChatState" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.next", "type": "Function", "tags": [], "label": "next", "description": [], "signature": [ "(messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]) => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.next.$1", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.UseChatResult.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatActionClickType", "type": "Enum", "tags": [], "label": "ChatActionClickType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatState", "type": "Enum", "tags": [], "label": "ChatState", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.FunctionVisibility", "type": "Enum", "tags": [], "label": "FunctionVisibility", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/function_visibility.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseEntryRole", "type": "Enum", "tags": [], "label": "KnowledgeBaseEntryRole", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.KnowledgeBaseType", "type": "Enum", "tags": [], "label": "KnowledgeBaseType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.MessageRole", "type": "Enum", "tags": [], "label": "MessageRole", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantTelemetryEventType", "type": "Enum", "tags": [], "label": "ObservabilityAIAssistantTelemetryEventType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/analytics/telemetry_event_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.StreamingChatResponseEventType", "type": "Enum", "tags": [], "label": "StreamingChatResponseEventType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.VisualizeESQLUserIntention", "type": "Enum", "tags": [], "label": "VisualizeESQLUserIntention", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/visualize_esql.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.AbortableAsyncState", "type": "Type", "tags": [], "label": "AbortableAsyncState", "description": [], "signature": [ "(T extends Promise ? State : State) & { refresh: () => void; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_abortable_async.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantLogsIndexPattern", "type": "string", "tags": [], "label": "aiAssistantLogsIndexPattern", "description": [], "signature": [ "\"observability:logSources\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantPreferredAIAssistantType", "type": "string", "tags": [], "label": "aiAssistantPreferredAIAssistantType", "description": [], "signature": [ "\"aiAssistant:preferredAIAssistantType\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantSearchConnectorIndexPattern", "type": "string", "tags": [], "label": "aiAssistantSearchConnectorIndexPattern", "description": [], "signature": [ "\"observability:aiAssistantSearchConnectorIndexPattern\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantSimulatedFunctionCalling", "type": "string", "tags": [], "label": "aiAssistantSimulatedFunctionCalling", "description": [], "signature": [ "\"observability:aiAssistantSimulatedFunctionCalling\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.APIReturnType", "type": "Type", "tags": [], "label": "APIReturnType", "description": [], "signature": [ "{ \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ entryId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/save\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/save\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/user_instructions\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { userInstructions: (", "Instruction", " & { public?: boolean | undefined; })[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/import\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/import\", ", "TypeC", "<{ body: ", "TypeC", "<{ entries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/kb/user_instructions\", ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", "; text: ", "StringC", "; public: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/entries\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/entries\", ", "TypeC", "<{ query: ", "TypeC", "<{ query: ", "StringC", "; sortBy: ", "StringC", "; sortDirection: ", "UnionC", "<[", "LiteralC", "<\"asc\">, ", "LiteralC", "<\"desc\">]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/status\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<", "InferenceInferenceEndpointInfo", "> | undefined; model_stats?: { deployment_state?: ", "MlDeploymentAssignmentState", " | undefined; allocation_state?: ", "MlDeploymentAllocationState", " | undefined; allocation_count?: number | undefined; } | undefined; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/reset\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { result: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/setup\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/setup\", ", "PartialC", "<{ query: ", "PartialC", "<{ model_id: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "InferenceInferenceEndpointInfo", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/summarize\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/summarize\", ", "TypeC", "<{ body: ", "TypeC", "<{ title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/recall\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ queries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ text: ", "StringC", "; }>, ", "PartialC", "<{ boost: ", "NumberC", "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", "<", "StringC", ">; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", "RecalledEntry", "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/functions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/functions\", ", "TypeC", "<{ query: ", "PartialC", "<{ scopes: ", "UnionC", "<[", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>, ", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { functionDefinitions: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]; systemMessage: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/connectors\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/connectors\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[], ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ title: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ conversation: ", "Type", "<", "ConversationUpdateRequest", ", ", "ConversationUpdateRequest", ", unknown>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversation\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversation\", ", "TypeC", "<{ body: ", "TypeC", "<{ conversation: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversations\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversations\", ", "PartialC", "<{ body: ", "PartialC", "<{ query: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { conversations: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /api/observability_ai_assistant/chat/complete 2023-10-31\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "PartialC", "<{ body: ", "PartialC", "<{ actions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; }>; query: ", "PartialC", "<{ format: ", "UnionC", "<[", "LiteralC", "<\"default\">, ", "LiteralC", "<\"openai\">]>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/complete\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/complete\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "TypeC", "<{ body: ", "TypeC", "<{ screenContexts: ", "ArrayC", "<", "Type", "<", "ObservabilityAIAssistantScreenContextRequest", ", ", "ObservabilityAIAssistantScreenContextRequest", ", unknown>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/recall\", ", "TypeC", "<{ body: ", "TypeC", "<{ prompt: ", "StringC", "; context: ", "StringC", "; connectorId: ", "StringC", "; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; systemMessage: ", "StringC", "; messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; functions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>, ", "PartialC", "<{ functionCall: ", "StringC", "; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/index_assets\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/index_assets\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; }[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, " ? TReturnType extends ", "IKibanaResponse", " | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", "ResponseErrorAttributes", " | undefined; } | undefined> ? TWrappedResponseType : TReturnType : never" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/api/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatActionClickHandler", "type": "Type", "tags": [], "label": "ChatActionClickHandler", "description": [], "signature": [ "(payload: ChatActionClickPayloadExecuteEsql) => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatActionClickHandler.$1", "type": "CompoundType", "tags": [], "label": "payload", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickType", "text": "ChatActionClickType" }, "; } & { query: string; userOverrides?: unknown; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatActionClickPayload", "type": "Type", "tags": [], "label": "ChatActionClickPayload", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickType", "text": "ChatActionClickType" }, "; } & { query: string; userOverrides?: unknown; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/chat/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ChatCompletionChunkEvent", "type": "Type", "tags": [], "label": "ChatCompletionChunkEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ChatCompletionChunk; } & { id: string; message: { content?: string | undefined; function_call?: { name?: string | undefined; arguments?: string | undefined; } | undefined; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.CompatibleJSONSchema", "type": "Type", "tags": [], "label": "CompatibleJSONSchema", "description": [], "signature": [ "{ type?: ", "JSONSchema7TypeName", " | undefined; enum?: JSONSchemaOrPrimitive[] | readonly JSONSchemaOrPrimitive[] | undefined; const?: JSONSchemaOrPrimitive | undefined; minLength?: number | undefined; maxLength?: number | undefined; items?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; required?: string[] | readonly string[] | undefined; properties?: Record | undefined; allOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; anyOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; oneOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; description?: string | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.elasticAiAssistantImage", "type": "string", "tags": [], "label": "elasticAiAssistantImage", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Feedback", "type": "Type", "tags": [], "label": "Feedback", "description": [], "signature": [ "\"negative\" | \"positive\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/components/buttons/feedback_buttons.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantAPIClientRequestParamsOf", "type": "Type", "tags": [], "label": "ObservabilityAIAssistantAPIClientRequestParamsOf", "description": [], "signature": [ "{ \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ entryId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/save\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/save\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/user_instructions\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { userInstructions: (", "Instruction", " & { public?: boolean | undefined; })[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/import\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/import\", ", "TypeC", "<{ body: ", "TypeC", "<{ entries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/kb/user_instructions\", ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", "; text: ", "StringC", "; public: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/entries\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/entries\", ", "TypeC", "<{ query: ", "TypeC", "<{ query: ", "StringC", "; sortBy: ", "StringC", "; sortDirection: ", "UnionC", "<[", "LiteralC", "<\"asc\">, ", "LiteralC", "<\"desc\">]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/status\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<", "InferenceInferenceEndpointInfo", "> | undefined; model_stats?: { deployment_state?: ", "MlDeploymentAssignmentState", " | undefined; allocation_state?: ", "MlDeploymentAllocationState", " | undefined; allocation_count?: number | undefined; } | undefined; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/reset\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { result: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/setup\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/setup\", ", "PartialC", "<{ query: ", "PartialC", "<{ model_id: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "InferenceInferenceEndpointInfo", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/summarize\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/summarize\", ", "TypeC", "<{ body: ", "TypeC", "<{ title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/recall\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ queries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ text: ", "StringC", "; }>, ", "PartialC", "<{ boost: ", "NumberC", "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", "<", "StringC", ">; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", "RecalledEntry", "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/functions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/functions\", ", "TypeC", "<{ query: ", "PartialC", "<{ scopes: ", "UnionC", "<[", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>, ", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { functionDefinitions: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]; systemMessage: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/connectors\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/connectors\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[], ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ title: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ conversation: ", "Type", "<", "ConversationUpdateRequest", ", ", "ConversationUpdateRequest", ", unknown>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversation\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversation\", ", "TypeC", "<{ body: ", "TypeC", "<{ conversation: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversations\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversations\", ", "PartialC", "<{ body: ", "PartialC", "<{ query: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { conversations: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /api/observability_ai_assistant/chat/complete 2023-10-31\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "PartialC", "<{ body: ", "PartialC", "<{ actions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; }>; query: ", "PartialC", "<{ format: ", "UnionC", "<[", "LiteralC", "<\"default\">, ", "LiteralC", "<\"openai\">]>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/complete\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/complete\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "TypeC", "<{ body: ", "TypeC", "<{ screenContexts: ", "ArrayC", "<", "Type", "<", "ObservabilityAIAssistantScreenContextRequest", ", ", "ObservabilityAIAssistantScreenContextRequest", ", unknown>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/recall\", ", "TypeC", "<{ body: ", "TypeC", "<{ prompt: ", "StringC", "; context: ", "StringC", "; connectorId: ", "StringC", "; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; systemMessage: ", "StringC", "; messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; functions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>, ", "PartialC", "<{ functionCall: ", "StringC", "; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/index_assets\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/index_assets\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; }[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, " ? TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.RouteParamsRT", "text": "RouteParamsRT" }, " ? ClientRequestParamsOfType : TRouteParamsRT extends undefined ? {} : never : never" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/api/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantAPIEndpoint", "type": "Type", "tags": [], "label": "ObservabilityAIAssistantAPIEndpoint", "description": [], "signature": [ "\"POST /internal/observability_ai_assistant/index_assets\" | \"POST /internal/observability_ai_assistant/chat\" | \"POST /internal/observability_ai_assistant/chat/recall\" | \"POST /internal/observability_ai_assistant/chat/complete\" | \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\" | \"GET /internal/observability_ai_assistant/conversation/{conversationId}\" | \"POST /internal/observability_ai_assistant/conversations\" | \"POST /internal/observability_ai_assistant/conversation\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\" | \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\" | \"GET /internal/observability_ai_assistant/connectors\" | \"GET /internal/observability_ai_assistant/functions\" | \"POST /internal/observability_ai_assistant/functions/recall\" | \"POST /internal/observability_ai_assistant/functions/summarize\" | \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\" | \"POST /internal/observability_ai_assistant/kb/setup\" | \"POST /internal/observability_ai_assistant/kb/reset\" | \"GET /internal/observability_ai_assistant/kb/status\" | \"GET /internal/observability_ai_assistant/kb/entries\" | \"PUT /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/import\" | \"GET /internal/observability_ai_assistant/kb/user_instructions\" | \"POST /internal/observability_ai_assistant/kb/entries/save\" | \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/api/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RegisterRenderFunctionDefinition", "type": "Type", "tags": [], "label": "RegisterRenderFunctionDefinition", "description": [], "signature": [ "(name: string, render: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.RenderFunction", "text": "RenderFunction" }, ") => void" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RegisterRenderFunctionDefinition.$1", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RegisterRenderFunctionDefinition.$2", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(options: { arguments: TFunctionArguments; response: TFunctionResponse; onActionClick: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" }, "; }) => React.ReactNode" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RegisterRenderFunctionDefinition.$2.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "{ arguments: TArguments; response: TResponse; onActionClick: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" }, "; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RenderFunction", "type": "Type", "tags": [], "label": "RenderFunction", "description": [], "signature": [ "(options: { arguments: TArguments; response: TResponse; onActionClick: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" }, "; }) => React.ReactNode" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.RenderFunction.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "{ arguments: TArguments; response: TResponse; onActionClick: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ChatActionClickHandler", "text": "ChatActionClickHandler" }, "; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.TelemetryEventTypeWithPayload", "type": "Type", "tags": [], "label": "TelemetryEventTypeWithPayload", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantTelemetryEventType", "text": "ObservabilityAIAssistantTelemetryEventType" }, ".ChatFeedback; payload: ", "ChatFeedback", "; } | { type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantTelemetryEventType", "text": "ObservabilityAIAssistantTelemetryEventType" }, ".InsightFeedback; payload: ", "InsightFeedback", "; } | { type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantTelemetryEventType", "text": "ObservabilityAIAssistantTelemetryEventType" }, ".UserSentPromptInChat; payload: ", "UserSentPrompt", "; } | { type: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantTelemetryEventType", "text": "ObservabilityAIAssistantTelemetryEventType" }, ".InsightResponse; payload: ", "InsightResponse", "; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/analytics/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.VISUALIZE_ESQL_USER_INTENTIONS", "type": "Array", "tags": [], "label": "VISUALIZE_ESQL_USER_INTENTIONS", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.VisualizeESQLUserIntention", "text": "VisualizeESQLUserIntention" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/visualize_esql.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantCapabilities", "type": "Object", "tags": [], "label": "aiAssistantCapabilities", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/capabilities.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.aiAssistantCapabilities.show", "type": "string", "tags": [], "label": "show", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/capabilities.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "setup": { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicSetup", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantPublicSetup", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantPublicStart", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.service", "type": "Object", "tags": [], "label": "service", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantService", "text": "ObservabilityAIAssistantService" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.ObservabilityAIAssistantContextualInsight", "type": "CompoundType", "tags": [], "label": "ObservabilityAIAssistantContextualInsight", "description": [], "signature": [ "React.ForwardRefExoticComponent<", "InsightProps", "> | null" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.ObservabilityAIAssistantMultipaneFlyoutContext", "type": "Object", "tags": [], "label": "ObservabilityAIAssistantMultipaneFlyoutContext", "description": [], "signature": [ "React.Context<", "ChatFlyoutSecondSlotHandler", " | undefined>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.ObservabilityAIAssistantChatServiceContext", "type": "Object", "tags": [], "label": "ObservabilityAIAssistantChatServiceContext", "description": [], "signature": [ "React.Context<", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" }, " | undefined>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.useObservabilityAIAssistantChatService", "type": "Function", "tags": [], "label": "useObservabilityAIAssistantChatService", "description": [], "signature": [ "() => ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.useGenAIConnectors", "type": "Function", "tags": [], "label": "useGenAIConnectors", "description": [], "signature": [ "() => ", "UseGenAIConnectorsResult" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.useChat", "type": "Function", "tags": [], "label": "useChat", "description": [], "signature": [ "(props: ", "UseChatProps", ") => ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.UseChatResult", "text": "UseChatResult" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.useChat.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ connectorId?: string | undefined; service: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantService", "text": "ObservabilityAIAssistantService" }, "; initialMessages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; initialConversationId?: string | undefined; chatService: ", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" }, "; persist: boolean; disableFunctions?: boolean | undefined; onConversationUpdate?: ((event: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationCreateEvent", "text": "ConversationCreateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationUpdateEvent", "text": "ConversationUpdateEvent" }, ") => void) | undefined; onChatComplete?: ((messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]) => void) | undefined; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/hooks/use_chat.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.getContextualInsightMessages", "type": "Function", "tags": [], "label": "getContextualInsightMessages", "description": [], "signature": [ "({}: { message: string; instructions: string; }) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.getContextualInsightMessages.$1", "type": "Object", "tags": [], "label": "{}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.getContextualInsightMessages.$1.message", "type": "string", "tags": [], "label": "message", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.getContextualInsightMessages.$1.instructions", "type": "string", "tags": [], "label": "instructions", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.createScreenContextAction", "type": "Function", "tags": [], "label": "createScreenContextAction", "description": [], "signature": [ ", \"respond\">, TRespondFunction extends ", "ScreenContextActionRespondFunction", ">>(definition: TActionDefinition, respond: TRespondFunction) => ", "ScreenContextActionDefinition", ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.createScreenContextAction.$1", "type": "Uncategorized", "tags": [], "label": "definition", "description": [], "signature": [ "TActionDefinition" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/utils/create_screen_context_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.createScreenContextAction.$2", "type": "Function", "tags": [], "label": "respond", "description": [], "signature": [ "TRespondFunction" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/public/utils/create_screen_context_action.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-public.ObservabilityAIAssistantPublicStart.createScreenContextAction.$2.$1", "type": "Object", "tags": [], "label": "__0", "description": [], "signature": [ "{ args: TArguments; signal: AbortSignal; connectorId: string; client: Pick<", { "pluginId": "observabilityAIAssistant", "scope": "public", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-public.ObservabilityAIAssistantChatService", "text": "ObservabilityAIAssistantChatService" }, ", \"complete\" | \"chat\">; messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ] } ] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient", "type": "Class", "tags": [], "label": "ObservabilityAIAssistantClient", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1", "type": "Object", "tags": [], "label": "dependencies", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.config", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "{ readonly scope?: \"search\" | \"observability\" | undefined; readonly enabled: boolean; readonly enableKnowledgeBase: boolean; readonly disableKbSemanticTextMigration: boolean; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.core", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ "CoreSetup", "<", "ObservabilityAIAssistantPluginStartDependencies", ", unknown>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.actionsClient", "type": "Object", "tags": [], "label": "actionsClient", "description": [], "signature": [ "{ execute: (connectorExecuteParams: ", "ConnectorExecuteParams", ") => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">; create: ({ action, options, }: Omit<", "ConnectorCreateParams", ", \"context\">) => Promise<", "Connector", ">; update: ({ id, action, }: Pick<", "ConnectorUpdateParams", ", \"id\" | \"action\">) => Promise<", "Connector", ">; get: ({ id, throwIfSystemAction, }: { id: string; throwIfSystemAction?: boolean | undefined; }) => Promise<", "Connector", ">; getAll: ({ includeSystemActions }?: { includeSystemActions?: boolean | undefined; }) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>; getAllSystemConnectors: () => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>; getBulk: ({ ids, throwIfSystemAction, }: { ids: string[]; throwIfSystemAction?: boolean | undefined; }) => Promise<", "Connector", "[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"jwt\" | \"client\"; options: Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; secrets: Readonly<{} & { clientSecret: string; }>; scope: string; }>; }>, configurationUtilities: ", "ActionsConfigurationUtilities", ") => Promise<{ accessToken: string | null; }>; delete: ({ id }: { id: string; }) => Promise<{}>; bulkEnqueueExecution: (options: ", "ExecuteOptions", "[]) => Promise<", "ExecutionResponse", ">; listTypes: ({ featureId, includeSystemActionTypes, }?: ", "ListTypesParams", ") => Promise<", "ConnectorType", "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; isSystemAction: (connectorId: string) => boolean; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.GetGlobalExecutionLogParams", "text": "GetGlobalExecutionLogParams" }, ") => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.IExecutionLogResult", "text": "IExecutionLogResult" }, ">; getGlobalExecutionKpiWithAuth: ({ dateStart, dateEnd, filter, namespaces, }: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.GetGlobalExecutionKPIParams", "text": "GetGlobalExecutionKPIParams" }, ") => Promise<{ success: number; unknown: number; failure: number; warning: number; }>; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.uiSettingsClient", "type": "Object", "tags": [], "label": "uiSettingsClient", "description": [], "signature": [ "IUiSettingsClient" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [], "signature": [ "{ asInternalUser: ", "ElasticsearchClient", "; asCurrentUser: ", "ElasticsearchClient", "; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.inferenceClient", "type": "Object", "tags": [], "label": "inferenceClient", "description": [], "signature": [ { "pluginId": "inference", "scope": "server", "docId": "kibInferencePluginApi", "section": "def-server.InferenceClient", "text": "InferenceClient" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.Logger", "text": "Logger" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.user", "type": "Object", "tags": [], "label": "user", "description": [], "signature": [ "{ id?: string | undefined; name: string; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.knowledgeBaseService", "type": "Object", "tags": [], "label": "knowledgeBaseService", "description": [], "signature": [ "KnowledgeBaseService" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.Unnamed.$1.scopes", "type": "Array", "tags": [], "label": "scopes", "description": [], "signature": [ { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(conversationId: string) => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.get.$1", "type": "string", "tags": [], "label": "conversationId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.delete", "type": "Function", "tags": [], "label": "delete", "description": [], "signature": [ "(conversationId: string) => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.delete.$1", "type": "string", "tags": [], "label": "conversationId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete", "type": "Function", "tags": [], "label": "complete", "description": [], "signature": [ "({ functionClient, connectorId, simulateFunctionCalling, instructions: adHocInstructions, messages: initialMessages, signal, persist, kibanaPublicUrl, isPublic, title: predefinedTitle, conversationId: predefinedConversationId, disableFunctions, }: { messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; connectorId: string; signal: AbortSignal; functionClient: ", "ChatFunctionClient", "; persist: boolean; conversationId?: string | undefined; title?: string | undefined; isPublic?: boolean | undefined; kibanaPublicUrl?: string | undefined; instructions?: ", "AdHocInstruction", "[] | undefined; simulateFunctionCalling?: boolean | undefined; disableFunctions?: boolean | { except: string[]; } | undefined; }) => ", "Observable", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationCreateEvent", "text": "ConversationCreateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationUpdateEvent", "text": "ConversationUpdateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionChunkEvent", "text": "ChatCompletionChunkEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionMessageEvent", "text": "ChatCompletionMessageEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.BufferFlushEvent", "text": "BufferFlushEvent" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1", "type": "Object", "tags": [], "label": "{\n functionClient,\n connectorId,\n simulateFunctionCalling = false,\n instructions: adHocInstructions = [],\n messages: initialMessages,\n signal,\n persist,\n kibanaPublicUrl,\n isPublic,\n title: predefinedTitle,\n conversationId: predefinedConversationId,\n disableFunctions = false,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.signal", "type": "Object", "tags": [], "label": "signal", "description": [], "signature": [ "AbortSignal" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.functionClient", "type": "Object", "tags": [], "label": "functionClient", "description": [], "signature": [ "ChatFunctionClient" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.persist", "type": "boolean", "tags": [], "label": "persist", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.conversationId", "type": "string", "tags": [], "label": "conversationId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.isPublic", "type": "CompoundType", "tags": [], "label": "isPublic", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.kibanaPublicUrl", "type": "string", "tags": [], "label": "kibanaPublicUrl", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.instructions", "type": "Array", "tags": [], "label": "instructions", "description": [], "signature": [ "AdHocInstruction", "[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.simulateFunctionCalling", "type": "CompoundType", "tags": [], "label": "simulateFunctionCalling", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.complete.$1.disableFunctions", "type": "CompoundType", "tags": [], "label": "disableFunctions", "description": [], "signature": [ "boolean | { except: string[]; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat", "type": "Function", "tags": [], "label": "chat", "description": [], "signature": [ "(name: string, { systemMessage, messages, connectorId, functions, functionCall, signal, simulateFunctionCalling, tracer, stream, }: { systemMessage?: string | undefined; messages: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]; connectorId: string; functions?: { name: string; description: string; parameters?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, " | undefined; }[] | undefined; functionCall?: string | undefined; signal: AbortSignal; simulateFunctionCalling?: boolean | undefined; tracer: ", "LangTracer", "; stream: TStream; }) => TStream extends true ? ", "Observable", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionChunkEvent", "text": "ChatCompletionChunkEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionMessageEvent", "text": "ChatCompletionMessageEvent" }, "> : Promise<", { "pluginId": "@kbn/inference-common", "scope": "common", "docId": "kibKbnInferenceCommonPluginApi", "section": "def-common.ChatCompleteResponse", "text": "ChatCompleteResponse" }, "<", { "pluginId": "@kbn/inference-common", "scope": "common", "docId": "kibKbnInferenceCommonPluginApi", "section": "def-common.ToolOptions", "text": "ToolOptions" }, ">>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2", "type": "Object", "tags": [], "label": "{\n systemMessage,\n messages,\n connectorId,\n functions,\n functionCall,\n signal,\n simulateFunctionCalling,\n tracer,\n stream,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.systemMessage", "type": "string", "tags": [], "label": "systemMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.functions", "type": "Array", "tags": [], "label": "functions", "description": [], "signature": [ "{ name: string; description: string; parameters?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, " | undefined; }[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.functionCall", "type": "string", "tags": [], "label": "functionCall", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.signal", "type": "Object", "tags": [], "label": "signal", "description": [], "signature": [ "AbortSignal" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.simulateFunctionCalling", "type": "CompoundType", "tags": [], "label": "simulateFunctionCalling", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.tracer", "type": "Object", "tags": [], "label": "tracer", "description": [], "signature": [ "LangTracer" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.chat.$2.stream", "type": "Uncategorized", "tags": [], "label": "stream", "description": [], "signature": [ "TStream" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.find", "type": "Function", "tags": [], "label": "find", "description": [], "signature": [ "(options?: { query?: string | undefined; } | undefined) => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.find.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.find.$1.query", "type": "string", "tags": [], "label": "query", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(conversationId: string, conversation: ", "ConversationUpdateRequest", ") => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.update.$1", "type": "string", "tags": [], "label": "conversationId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.update.$2", "type": "CompoundType", "tags": [], "label": "conversation", "description": [], "signature": [ "ConversationUpdateRequest" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setTitle", "type": "Function", "tags": [], "label": "setTitle", "description": [], "signature": [ "({ conversationId, title }: { conversationId: string; title: string; }) => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setTitle.$1", "type": "Object", "tags": [], "label": "{ conversationId, title }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setTitle.$1.conversationId", "type": "string", "tags": [], "label": "conversationId", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setTitle.$1.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.create", "type": "Function", "tags": [], "label": "create", "description": [], "signature": [ "(conversation: ConversationRequestBase) => Promise<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.create.$1", "type": "CompoundType", "tags": [], "label": "conversation", "description": [], "signature": [ "ConversationRequestBase" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.recall", "type": "Function", "tags": [], "label": "recall", "description": [], "signature": [ "({ queries, categories, limit, }: { queries: { text: string; boost?: number | undefined; }[]; categories?: string[] | undefined; limit?: { size?: number | undefined; tokenCount?: number | undefined; } | undefined; }) => Promise<", "RecalledEntry", "[]>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.recall.$1", "type": "Object", "tags": [], "label": "{\n queries,\n categories,\n limit,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.recall.$1.queries", "type": "Array", "tags": [], "label": "queries", "description": [], "signature": [ "{ text: string; boost?: number | undefined; }[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.recall.$1.categories", "type": "Array", "tags": [], "label": "categories", "description": [], "signature": [ "string[] | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.recall.$1.limit", "type": "Object", "tags": [], "label": "limit", "description": [], "signature": [ "{ size?: number | undefined; tokenCount?: number | undefined; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseStatus", "type": "Function", "tags": [], "label": "getKnowledgeBaseStatus", "description": [], "signature": [ "() => Promise<{ ready: boolean; enabled: boolean; errorMessage: string; endpoint?: undefined; model_stats?: undefined; } | { endpoint: ", "InferenceInferenceEndpointInfo", "; ready: boolean; enabled: boolean; model_stats: { allocation_count: number; deployment_state: ", "MlDeploymentAssignmentState", " | undefined; allocation_state: ", "MlDeploymentAllocationState", " | undefined; }; errorMessage?: undefined; }>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setupKnowledgeBase", "type": "Function", "tags": [], "label": "setupKnowledgeBase", "description": [], "signature": [ "(modelId: string | undefined) => Promise<", "InferenceInferenceEndpointInfo", ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.setupKnowledgeBase.$1", "type": "string", "tags": [], "label": "modelId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.resetKnowledgeBase", "type": "Function", "tags": [], "label": "resetKnowledgeBase", "description": [], "signature": [ "() => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.reIndexKnowledgeBaseAndPopulateSemanticTextField", "type": "Function", "tags": [], "label": "reIndexKnowledgeBaseAndPopulateSemanticTextField", "description": [], "signature": [ "() => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addUserInstruction", "type": "Function", "tags": [], "label": "addUserInstruction", "description": [], "signature": [ "({ entry, }: { entry: Omit<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, ", \"type\" | \"@timestamp\" | \"role\" | \"confidence\" | \"is_correction\">; }) => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addUserInstruction.$1", "type": "Object", "tags": [], "label": "{\n entry,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addUserInstruction.$1.entry", "type": "Object", "tags": [], "label": "entry", "description": [], "signature": [ "{ id: string; text: string; title?: string | undefined; labels?: Record | undefined; public: boolean; user?: { name: string; } | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addKnowledgeBaseEntry", "type": "Function", "tags": [], "label": "addKnowledgeBaseEntry", "description": [], "signature": [ "({ entry, }: { entry: Omit<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, ", \"type\" | \"@timestamp\">; }) => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addKnowledgeBaseEntry.$1", "type": "Object", "tags": [], "label": "{\n entry,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.addKnowledgeBaseEntry.$1.entry", "type": "Object", "tags": [], "label": "entry", "description": [], "signature": [ "{ id: string; text: string; title?: string | undefined; role: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, "; labels?: Record | undefined; public: boolean; user?: { name: string; } | undefined; confidence: \"medium\" | \"high\" | \"low\"; is_correction: boolean; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseEntries", "type": "Function", "tags": [], "label": "getKnowledgeBaseEntries", "description": [], "signature": [ "({ query, sortBy, sortDirection, }: { query: string; sortBy: string; sortDirection: \"asc\" | \"desc\"; }) => Promise<{ entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseEntries.$1", "type": "Object", "tags": [], "label": "{\n query,\n sortBy,\n sortDirection,\n }", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseEntries.$1.query", "type": "string", "tags": [], "label": "query", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseEntries.$1.sortBy", "type": "string", "tags": [], "label": "sortBy", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseEntries.$1.sortDirection", "type": "CompoundType", "tags": [], "label": "sortDirection", "description": [], "signature": [ "\"asc\" | \"desc\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.deleteKnowledgeBaseEntry", "type": "Function", "tags": [], "label": "deleteKnowledgeBaseEntry", "description": [], "signature": [ "(id: string) => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.deleteKnowledgeBaseEntry.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantClient.getKnowledgeBaseUserInstructions", "type": "Function", "tags": [], "label": "getKnowledgeBaseUserInstructions", "description": [], "signature": [ "() => Promise<(", "Instruction", " & { public?: boolean | undefined; })[]>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/client/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionRequestMessage", "type": "Function", "tags": [], "label": "createFunctionRequestMessage", "description": [], "signature": [ "({\n name,\n args,\n}: { name: string; args?: Record | undefined; }) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionRequestMessage.$1", "type": "Object", "tags": [], "label": "{\n name,\n args,\n}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionRequestMessage.$1.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionRequestMessage.$1.args", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_request_message.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionResponseMessage", "type": "Function", "tags": [], "label": "createFunctionResponseMessage", "description": [], "signature": [ "({\n name,\n content,\n data,\n}: { name: string; content: unknown; data?: unknown; }) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionResponseMessage.$1", "type": "Object", "tags": [], "label": "{\n name,\n content,\n data,\n}", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionResponseMessage.$1.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionResponseMessage.$1.content", "type": "Unknown", "tags": [], "label": "content", "description": [], "signature": [ "unknown" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.createFunctionResponseMessage.$1.data", "type": "Unknown", "tags": [], "label": "data", "description": [], "signature": [ "unknown" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/create_function_response_message.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.streamIntoObservable", "type": "Function", "tags": [], "label": "streamIntoObservable", "description": [], "signature": [ "(readable: ", "Readable", ") => ", "Observable", "" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/util/stream_into_observable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.streamIntoObservable.$1", "type": "Object", "tags": [], "label": "readable", "description": [], "signature": [ "Readable" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/util/stream_into_observable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.aiAssistantLogsIndexPattern", "type": "string", "tags": [], "label": "aiAssistantLogsIndexPattern", "description": [], "signature": [ "\"observability:logSources\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.aiAssistantSearchConnectorIndexPattern", "type": "string", "tags": [], "label": "aiAssistantSearchConnectorIndexPattern", "description": [], "signature": [ "\"observability:aiAssistantSearchConnectorIndexPattern\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.aiAssistantSimulatedFunctionCalling", "type": "string", "tags": [], "label": "aiAssistantSimulatedFunctionCalling", "description": [], "signature": [ "\"observability:aiAssistantSimulatedFunctionCalling\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantServerRouteRepository", "type": "Type", "tags": [], "label": "ObservabilityAIAssistantServerRouteRepository", "description": [], "signature": [ "{ \"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/kb/entries/{entryId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ entryId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/save\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/save\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/user_instructions\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { userInstructions: (", "Instruction", " & { public?: boolean | undefined; })[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/entries/import\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/entries/import\", ", "TypeC", "<{ body: ", "TypeC", "<{ entries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ id: ", "StringC", "; title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; }>, ", "PartialC", "<{ confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; role: ", "UnionC", "<[", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".AssistantSummarization>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".UserEntry>, ", "LiteralC", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" }, ".Elastic>]>; }>]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/kb/user_instructions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/kb/user_instructions\", ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", "; text: ", "StringC", "; public: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/entries\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/entries\", ", "TypeC", "<{ query: ", "TypeC", "<{ query: ", "StringC", "; sortBy: ", "StringC", "; sortDirection: ", "UnionC", "<[", "LiteralC", "<\"asc\">, ", "LiteralC", "<\"desc\">]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntry", "text": "KnowledgeBaseEntry" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/kb/status\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/kb/status\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { errorMessage?: string | undefined; ready: boolean; enabled: boolean; endpoint?: Partial<", "InferenceInferenceEndpointInfo", "> | undefined; model_stats?: { deployment_state?: ", "MlDeploymentAssignmentState", " | undefined; allocation_state?: ", "MlDeploymentAllocationState", " | undefined; allocation_count?: number | undefined; } | undefined; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/reset\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/reset\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", { result: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/setup\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/setup\", ", "PartialC", "<{ query: ", "PartialC", "<{ model_id: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "InferenceInferenceEndpointInfo", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/kb/migrations/kb_semantic_text\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/summarize\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/summarize\", ", "TypeC", "<{ body: ", "TypeC", "<{ title: ", "StringC", "; text: ", "BrandC", "<", "StringC", ", ", { "pluginId": "@kbn/io-ts-utils", "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">; confidence: ", "UnionC", "<[", "LiteralC", "<\"low\">, ", "LiteralC", "<\"medium\">, ", "LiteralC", "<\"high\">]>; is_correction: ", "Type", "; public: ", "Type", "; labels: ", "RecordC", "<", "StringC", ", ", "StringC", ">; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/functions/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/functions/recall\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ queries: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ text: ", "StringC", "; }>, ", "PartialC", "<{ boost: ", "NumberC", "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", "<", "StringC", ">; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { entries: ", "RecalledEntry", "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/functions\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/functions\", ", "TypeC", "<{ query: ", "PartialC", "<{ scopes: ", "UnionC", "<[", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>, ", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>]>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { functionDefinitions: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, ">[]; systemMessage: string; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/connectors\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/connectors\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[], ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ title: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"PUT /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; body: ", "TypeC", "<{ conversation: ", "Type", "<", "ConversationUpdateRequest", ", ", "ConversationUpdateRequest", ", unknown>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversation\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversation\", ", "TypeC", "<{ body: ", "TypeC", "<{ conversation: ", "Type", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/conversations\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/conversations\", ", "PartialC", "<{ body: ", "PartialC", "<{ query: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", { conversations: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, "[]; }, ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"GET /internal/observability_ai_assistant/conversation/{conversationId}\", ", "TypeC", "<{ path: ", "TypeC", "<{ conversationId: ", "StringC", "; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /api/observability_ai_assistant/chat/complete 2023-10-31\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /api/observability_ai_assistant/chat/complete 2023-10-31\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "PartialC", "<{ body: ", "PartialC", "<{ actions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; }>; query: ", "PartialC", "<{ format: ", "UnionC", "<[", "LiteralC", "<\"default\">, ", "LiteralC", "<\"openai\">]>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/complete\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/complete\", ", "IntersectionC", "<[", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; persist: ", "Type", "; }>, ", "PartialC", "<{ conversationId: ", "StringC", "; title: ", "StringC", "; disableFunctions: ", "UnionC", "<[", "Type", ", ", "TypeC", "<{ except: ", "ArrayC", "<", "StringC", ">; }>]>; instructions: ", "ArrayC", "<", "IntersectionC", "<[", "PartialC", "<{ id: ", "StringC", "; }>, ", "TypeC", "<{ text: ", "StringC", "; instruction_type: ", "UnionC", "<[", "LiteralC", "<\"user_instruction\">, ", "LiteralC", "<\"application_instruction\">]>; }>]>>; }>]>; }>, ", "TypeC", "<{ body: ", "TypeC", "<{ screenContexts: ", "ArrayC", "<", "Type", "<", "ObservabilityAIAssistantScreenContextRequest", ", ", "ObservabilityAIAssistantScreenContextRequest", ", unknown>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>]>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat/recall\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat/recall\", ", "TypeC", "<{ body: ", "TypeC", "<{ prompt: ", "StringC", "; context: ", "StringC", "; connectorId: ", "StringC", "; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/chat\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/chat\", ", "TypeC", "<{ body: ", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; systemMessage: ", "StringC", "; messages: ", "ArrayC", "<", "Type", "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, ", unknown>>; connectorId: ", "StringC", "; functions: ", "ArrayC", "<", "IntersectionC", "<[", "TypeC", "<{ name: ", "StringC", "; description: ", "StringC", "; }>, ", "PartialC", "<{ parameters: ", "AnyC", "; }>]>>; scopes: ", "ArrayC", "<", "UnionC", "<[", "LiteralC", "<\"observability\">, ", "LiteralC", "<\"search\">, ", "LiteralC", "<\"all\">]>>; }>, ", "PartialC", "<{ functionCall: ", "StringC", "; }>]>; }>, ", "ObservabilityAIAssistantRouteHandlerResources", ", ", "Readable", ", ", "ObservabilityAIAssistantRouteCreateOptions", ">; \"POST /internal/observability_ai_assistant/index_assets\": ", { "pluginId": "@kbn/server-route-repository-utils", "scope": "common", "docId": "kibKbnServerRouteRepositoryUtilsPluginApi", "section": "def-common.ServerRoute", "text": "ServerRoute" }, "<\"POST /internal/observability_ai_assistant/index_assets\", undefined, ", "ObservabilityAIAssistantRouteHandlerResources", ", void, ", "ObservabilityAIAssistantRouteCreateOptions", ">; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/routes/get_global_observability_ai_assistant_route_repository.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-server.RegistrationCallback", "type": "Type", "tags": [], "label": "RegistrationCallback", "description": [], "signature": [ "({}: { signal: AbortSignal; resources: ", "RespondFunctionResources", "; client: ", { "pluginId": "observabilityAIAssistant", "scope": "server", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-server.ObservabilityAIAssistantClient", "text": "ObservabilityAIAssistantClient" }, "; functions: ", "ChatFunctionClient", "; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; }) => Promise" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.RegistrationCallback.$1", "type": "Object", "tags": [], "label": "__0", "description": [], "signature": [ "{ signal: AbortSignal; resources: ", "RespondFunctionResources", "; client: ", { "pluginId": "observabilityAIAssistant", "scope": "server", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-server.ObservabilityAIAssistantClient", "text": "ObservabilityAIAssistantClient" }, "; functions: ", "ChatFunctionClient", "; scopes: ", { "pluginId": "@kbn/ai-assistant-common", "scope": "common", "docId": "kibKbnAiAssistantCommonPluginApi", "section": "def-common.AssistantScope", "text": "AssistantScope" }, "[]; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "objects": [], "start": { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantServerStart", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantServerStart", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantServerStart.service", "type": "Object", "tags": [], "label": "service", "description": [ "\nReturns a Observability AI Assistant service instance" ], "signature": [ "ObservabilityAIAssistantService" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true }, "setup": { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantServerSetup", "type": "Interface", "tags": [], "label": "ObservabilityAIAssistantServerSetup", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-server.ObservabilityAIAssistantServerSetup.service", "type": "Object", "tags": [], "label": "service", "description": [ "\nReturns a Observability AI Assistant service instance" ], "signature": [ "ObservabilityAIAssistantService" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true } }, "common": { "classes": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionError", "type": "Class", "tags": [], "label": "ChatCompletionError", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionError", "text": "ChatCompletionError" }, " extends Error" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionError.Unnamed.$1", "type": "Uncategorized", "tags": [], "label": "code", "description": [], "signature": [ "T" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionError.Unnamed.$2", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionError.Unnamed.$3", "type": "Uncategorized", "tags": [], "label": "meta", "description": [], "signature": [ "ErrorMetaAttributes[T]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable", "type": "Class", "tags": [], "label": "ShortIdTable", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable.take", "type": "Function", "tags": [], "label": "take", "description": [], "signature": [ "(originalId: string) => string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable.take.$1", "type": "string", "tags": [], "label": "originalId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable.lookup", "type": "Function", "tags": [], "label": "lookup", "description": [], "signature": [ "(shortId: string) => string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ShortIdTable.lookup.$1", "type": "string", "tags": [], "label": "shortId", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/short_id_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.concatenateChatCompletionChunks", "type": "Function", "tags": [], "label": "concatenateChatCompletionChunks", "description": [], "signature": [ "() => (source: ", "Observable", "<", "ChatEvent", ">) => ", "Observable", "<", "ConcatenatedMessage", ">" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/utils/concatenate_chat_completion_chunks.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createConversationNotFoundError", "type": "Function", "tags": [], "label": "createConversationNotFoundError", "description": [], "signature": [ "() => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionError", "text": "ChatCompletionError" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorCode", "text": "ChatCompletionErrorCode" }, ".NotFoundError>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createFunctionNotFoundError", "type": "Function", "tags": [], "label": "createFunctionNotFoundError", "description": [], "signature": [ "(name: string) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionError", "text": "ChatCompletionError" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorCode", "text": "ChatCompletionErrorCode" }, ".FunctionNotFoundError>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createFunctionNotFoundError.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createInternalServerError", "type": "Function", "tags": [], "label": "createInternalServerError", "description": [], "signature": [ "(originalErrorMessage: string) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionError", "text": "ChatCompletionError" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorCode", "text": "ChatCompletionErrorCode" }, ".InternalError>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createInternalServerError.$1", "type": "string", "tags": [], "label": "originalErrorMessage", "description": [], "signature": [ "string" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createTokenLimitReachedError", "type": "Function", "tags": [], "label": "createTokenLimitReachedError", "description": [], "signature": [ "(tokenLimit: number | undefined, tokenCount: number | undefined) => ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionError", "text": "ChatCompletionError" }, "<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorCode", "text": "ChatCompletionErrorCode" }, ".TokenLimitReachedError>" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createTokenLimitReachedError.$1", "type": "number", "tags": [], "label": "tokenLimit", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.createTokenLimitReachedError.$2", "type": "number", "tags": [], "label": "tokenCount", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.isChatCompletionError", "type": "Function", "tags": [], "label": "isChatCompletionError", "description": [], "signature": [ "(error: Error) => boolean" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.isChatCompletionError.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "Error" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.isTokenLimitReachedError", "type": "Function", "tags": [], "label": "isTokenLimitReachedError", "description": [], "signature": [ "(error: Error) => boolean" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.isTokenLimitReachedError.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "Error" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation", "type": "Interface", "tags": [], "label": "Conversation", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.user", "type": "Object", "tags": [], "label": "user", "description": [], "signature": [ "{ id?: string | undefined; name: string; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.conversation", "type": "Object", "tags": [], "label": "conversation", "description": [], "signature": [ "{ id: string; title: string; last_updated: string; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.systemMessage", "type": "string", "tags": [], "label": "systemMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.messages", "type": "Array", "tags": [], "label": "messages", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.labels", "type": "Object", "tags": [], "label": "labels", "description": [], "signature": [ "{ [x: string]: string; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.numeric_labels", "type": "Object", "tags": [], "label": "numeric_labels", "description": [], "signature": [ "{ [x: string]: number; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Conversation.public", "type": "boolean", "tags": [], "label": "public", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition", "type": "Interface", "tags": [], "label": "FunctionDefinition", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionDefinition", "text": "FunctionDefinition" }, "" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition.visibility", "type": "CompoundType", "tags": [], "label": "visibility", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.FunctionVisibility", "text": "FunctionVisibility" }, " | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition.descriptionForUser", "type": "string", "tags": [], "label": "descriptionForUser", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionDefinition.parameters", "type": "Uncategorized", "tags": [], "label": "parameters", "description": [], "signature": [ "TParameters | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry", "type": "Interface", "tags": [], "label": "KnowledgeBaseEntry", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.text", "type": "string", "tags": [], "label": "text", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.confidence", "type": "CompoundType", "tags": [], "label": "confidence", "description": [], "signature": [ "\"medium\" | \"high\" | \"low\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.is_correction", "type": "boolean", "tags": [], "label": "is_correction", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"user_instruction\" | \"contextual\" | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.public", "type": "boolean", "tags": [], "label": "public", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.labels", "type": "Object", "tags": [], "label": "labels", "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.role", "type": "Enum", "tags": [], "label": "role", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.KnowledgeBaseEntryRole", "text": "KnowledgeBaseEntryRole" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntry.user", "type": "Object", "tags": [], "label": "user", "description": [], "signature": [ "{ name: string; } | undefined" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Message", "type": "Interface", "tags": [], "label": "Message", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Message.timestamp", "type": "string", "tags": [], "label": "'@timestamp'", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.Message.message", "type": "Object", "tags": [], "label": "message", "description": [], "signature": [ "{ content?: string | undefined; name?: string | undefined; role: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, "; function_call?: { name: string; arguments?: string | undefined; trigger: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".Assistant | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".User | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageRole", "text": "MessageRole" }, ".Elastic; } | undefined; data?: string | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionErrorCode", "type": "Enum", "tags": [], "label": "ChatCompletionErrorCode", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.FunctionVisibility", "type": "Enum", "tags": [], "label": "FunctionVisibility", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/function_visibility.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseEntryRole", "type": "Enum", "tags": [], "label": "KnowledgeBaseEntryRole", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.KnowledgeBaseType", "type": "Enum", "tags": [], "label": "KnowledgeBaseType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.MessageRole", "type": "Enum", "tags": [], "label": "MessageRole", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.StreamingChatResponseEventType", "type": "Enum", "tags": [], "label": "StreamingChatResponseEventType", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.VisualizeESQLUserIntention", "type": "Enum", "tags": [], "label": "VisualizeESQLUserIntention", "description": [], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/visualize_esql.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "observabilityAIAssistant", "id": "def-common.aiAssistantLogsIndexPattern", "type": "string", "tags": [], "label": "aiAssistantLogsIndexPattern", "description": [], "signature": [ "\"observability:logSources\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.aiAssistantSearchConnectorIndexPattern", "type": "string", "tags": [], "label": "aiAssistantSearchConnectorIndexPattern", "description": [], "signature": [ "\"observability:aiAssistantSearchConnectorIndexPattern\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.aiAssistantSimulatedFunctionCalling", "type": "string", "tags": [], "label": "aiAssistantSimulatedFunctionCalling", "description": [], "signature": [ "\"observability:aiAssistantSimulatedFunctionCalling\"" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/ui_settings/settings_keys.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.BufferFlushEvent", "type": "Type", "tags": [], "label": "BufferFlushEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".BufferFlush; } & { data?: string | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionChunkEvent", "type": "Type", "tags": [], "label": "ChatCompletionChunkEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ChatCompletionChunk; } & { id: string; message: { content?: string | undefined; function_call?: { name?: string | undefined; arguments?: string | undefined; } | undefined; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionErrorEvent", "type": "Type", "tags": [], "label": "ChatCompletionErrorEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ChatCompletionError; } & { error: { message: string; stack?: string | undefined; code?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorCode", "text": "ChatCompletionErrorCode" }, " | undefined; meta?: Record | undefined; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ChatCompletionMessageEvent", "type": "Type", "tags": [], "label": "ChatCompletionMessageEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ChatCompletionMessage; } & { id: string; message: { content?: string | undefined; function_call?: { name?: string | undefined; arguments?: string | undefined; } | undefined; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.CompatibleJSONSchema", "type": "Type", "tags": [], "label": "CompatibleJSONSchema", "description": [], "signature": [ "{ type?: ", "JSONSchema7TypeName", " | undefined; enum?: JSONSchemaOrPrimitive[] | readonly JSONSchemaOrPrimitive[] | undefined; const?: JSONSchemaOrPrimitive | undefined; minLength?: number | undefined; maxLength?: number | undefined; items?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; required?: string[] | readonly string[] | undefined; properties?: Record | undefined; allOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; anyOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; oneOf?: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | readonly ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.CompatibleJSONSchema", "text": "CompatibleJSONSchema" }, "[] | undefined; description?: string | undefined; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ConversationCreateEvent", "type": "Type", "tags": [], "label": "ConversationCreateEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ConversationCreate; } & { conversation: { id: string; title: string; last_updated: string; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ConversationCreateRequest", "type": "Type", "tags": [], "label": "ConversationCreateRequest", "description": [], "signature": [ "Omit<", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Conversation", "text": "Conversation" }, ", \"namespace\" | \"user\" | \"conversation\"> & { conversation: { title: string; id?: string | undefined; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.ConversationUpdateEvent", "type": "Type", "tags": [], "label": "ConversationUpdateEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".ConversationUpdate; } & { conversation: { id: string; title: string; last_updated: string; }; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.MessageAddEvent", "type": "Type", "tags": [], "label": "MessageAddEvent", "description": [], "signature": [ "{ type: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.StreamingChatResponseEventType", "text": "StreamingChatResponseEventType" }, ".MessageAdd; } & { message: ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.Message", "text": "Message" }, "; id: string; }" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.StreamingChatResponseEvent", "type": "Type", "tags": [], "label": "StreamingChatResponseEvent", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationCreateEvent", "text": "ConversationCreateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationUpdateEvent", "text": "ConversationUpdateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionChunkEvent", "text": "ChatCompletionChunkEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionMessageEvent", "text": "ChatCompletionMessageEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionErrorEvent", "text": "ChatCompletionErrorEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.BufferFlushEvent", "text": "BufferFlushEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.StreamingChatResponseEventWithoutError", "type": "Type", "tags": [], "label": "StreamingChatResponseEventWithoutError", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationCreateEvent", "text": "ConversationCreateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ConversationUpdateEvent", "text": "ConversationUpdateEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.MessageAddEvent", "text": "MessageAddEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionChunkEvent", "text": "ChatCompletionChunkEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.ChatCompletionMessageEvent", "text": "ChatCompletionMessageEvent" }, " | ", { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.BufferFlushEvent", "text": "BufferFlushEvent" } ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/conversation_complete.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "observabilityAIAssistant", "id": "def-common.VISUALIZE_ESQL_USER_INTENTIONS", "type": "Array", "tags": [], "label": "VISUALIZE_ESQL_USER_INTENTIONS", "description": [], "signature": [ { "pluginId": "observabilityAIAssistant", "scope": "common", "docId": "kibObservabilityAIAssistantPluginApi", "section": "def-common.VisualizeESQLUserIntention", "text": "VisualizeESQLUserIntention" }, "[]" ], "path": "x-pack/platform/plugins/shared/observability_ai_assistant/common/functions/visualize_esql.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }