kibana/api_docs/observability_a_i_assistant.devdocs.json

1853 lines
No EOL
92 KiB
JSON

{
"id": "observabilityAIAssistant",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ContextualInsight",
"type": "Function",
"tags": [],
"label": "ContextualInsight",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<{ messages: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; title: string; } & React.RefAttributes<{}>>"
],
"path": "x-pack/plugins/observability_ai_assistant/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ContextualInsight.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantActionMenuItem",
"type": "Function",
"tags": [],
"label": "ObservabilityAIAssistantActionMenuItem",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<React.RefAttributes<{}>>"
],
"path": "x-pack/plugins/observability_ai_assistant/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantActionMenuItem.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantProvider",
"type": "Function",
"tags": [],
"label": "ObservabilityAIAssistantProvider",
"description": [],
"signature": [
"React.ProviderExoticComponent<React.ProviderProps<",
"ObservabilityAIAssistantService",
" | undefined>>"
],
"path": "x-pack/plugins/observability_ai_assistant/public/context/observability_ai_assistant_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantProvider.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.useObservabilityAIAssistant",
"type": "Function",
"tags": [],
"label": "useObservabilityAIAssistant",
"description": [],
"signature": [
"() => ",
"ObservabilityAIAssistantService"
],
"path": "x-pack/plugins/observability_ai_assistant/public/hooks/use_observability_ai_assistant.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.useObservabilityAIAssistantOptional",
"type": "Function",
"tags": [],
"label": "useObservabilityAIAssistantOptional",
"description": [],
"signature": [
"() => ",
"ObservabilityAIAssistantService",
" | undefined"
],
"path": "x-pack/plugins/observability_ai_assistant/public/hooks/use_observability_ai_assistant.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.Conversation",
"type": "Interface",
"tags": [],
"label": "Conversation",
"description": [],
"path": "x-pack/plugins/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/plugins/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; }"
],
"path": "x-pack/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/observability_ai_assistant/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.MessageRole",
"type": "Enum",
"tags": [],
"label": "MessageRole",
"description": [],
"path": "x-pack/plugins/observability_ai_assistant/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.APIReturnType",
"type": "Type",
"tags": [],
"label": "APIReturnType",
"description": [],
"signature": [
"{ \"POST /internal/observability_ai_assistant/functions/alerts\": { endpoint: \"POST /internal/observability_ai_assistant/functions/alerts\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ featureIds: ",
"ArrayC",
"<",
"StringC",
">; start: ",
"StringC",
"; end: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; includeRecovered: ",
"Type",
"<boolean, boolean, unknown>; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { featureIds: string[]; start: string; end: string; } & { filter?: string | undefined; includeRecovered?: boolean | undefined; }; }; }) => Promise<{ content: { total: number; alerts: OutputOf<SetOptional<{ readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>[]; }; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/functions/kb_status\": { endpoint: \"GET /internal/observability_ai_assistant/functions/kb_status\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{ ready: boolean; error?: any; deployment_state?: string | undefined; allocation_state?: string | undefined; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/setup_kb\": { endpoint: \"POST /internal/observability_ai_assistant/functions/setup_kb\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{}>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/summarize\": { endpoint: \"POST /internal/observability_ai_assistant/functions/summarize\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ id: ",
"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",
"<boolean, boolean, unknown>; public: ",
"Type",
"<boolean, boolean, unknown>; labels: ",
"RecordC",
"<",
"StringC",
", ",
"StringC",
">; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { id: string; text: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">; confidence: \"medium\" | \"high\" | \"low\"; is_correction: boolean; public: boolean; labels: { [x: string]: string; }; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/recall\": { endpoint: \"POST /internal/observability_ai_assistant/functions/recall\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ queries: ",
"ArrayC",
"<",
"BrandC",
"<",
"StringC",
", ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">>; }>, ",
"PartialC",
"<{ contexts: ",
"ArrayC",
"<",
"StringC",
">; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { queries: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">[]; } & { contexts?: string[] | undefined; }; }; }) => Promise<{ entries: ",
"RecalledEntry",
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/elasticsearch\": { endpoint: \"POST /internal/observability_ai_assistant/functions/elasticsearch\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ method: ",
"UnionC",
"<[",
"LiteralC",
"<\"GET\">, ",
"LiteralC",
"<\"POST\">, ",
"LiteralC",
"<\"PATCH\">, ",
"LiteralC",
"<\"PUT\">, ",
"LiteralC",
"<\"DELETE\">]>; path: ",
"StringC",
"; }>, ",
"PartialC",
"<{ body: ",
"AnyC",
"; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { method: \"GET\" | \"DELETE\" | \"POST\" | \"PUT\" | \"PATCH\"; path: string; } & { body?: any; }; }; }) => Promise<unknown>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/connectors\": { endpoint: \"GET /internal/observability_ai_assistant/connectors\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.FindConnectorResult",
"text": "FindConnectorResult"
},
"[]>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { title: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ connectorId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { connectorId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationUpdateRequest",
", ",
"ConversationUpdateRequest",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { conversation: ",
"ConversationUpdateRequest",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversation\": { endpoint: \"POST /internal/observability_ai_assistant/conversation\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationRequestBase",
", ",
"ConversationRequestBase",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { conversation: ",
"ConversationRequestBase",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversations\": { endpoint: \"POST /internal/observability_ai_assistant/conversations\"; params?: ",
"PartialC",
"<{ body: ",
"PartialC",
"<{ query: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params?: { body?: { query?: string | undefined; } | undefined; } | undefined; }) => Promise<{ conversations: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"GET /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/chat\": { endpoint: \"POST /internal/observability_ai_assistant/chat\"; params?: ",
"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",
"; functions: ",
"ArrayC",
"<",
"TypeC",
"<{ name: ",
"StringC",
"; description: ",
"StringC",
"; parameters: ",
"AnyC",
"; }>>; }>, ",
"PartialC",
"<{ functionCall: ",
"StringC",
"; }>]>; }>, ",
"PartialC",
"<{ query: ",
"TypeC",
"<{ stream: ",
"Type",
"<boolean, boolean, unknown>; }>; }>]> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { messages: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; connectorId: string; functions: { name: string; description: string; parameters: any; }[]; } & { functionCall?: string | undefined; }; } & { query?: { stream: boolean; } | undefined; }; }) => Promise<",
"IncomingMessage",
" | ",
"CreateChatCompletionResponse",
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; }[TEndpoint] extends { endpoint: any; params?: any; handler: ({}: any) => Promise<infer TReturnType>; } & ",
"ServerRouteCreateOptions",
" ? TReturnType : never"
],
"path": "x-pack/plugins/observability_ai_assistant/public/api/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantAPIClientRequestParamsOf",
"type": "Type",
"tags": [],
"label": "ObservabilityAIAssistantAPIClientRequestParamsOf",
"description": [],
"signature": [
"{ \"POST /internal/observability_ai_assistant/functions/alerts\": { endpoint: \"POST /internal/observability_ai_assistant/functions/alerts\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ featureIds: ",
"ArrayC",
"<",
"StringC",
">; start: ",
"StringC",
"; end: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; includeRecovered: ",
"Type",
"<boolean, boolean, unknown>; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { featureIds: string[]; start: string; end: string; } & { filter?: string | undefined; includeRecovered?: boolean | undefined; }; }; }) => Promise<{ content: { total: number; alerts: OutputOf<SetOptional<{ readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>[]; }; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/functions/kb_status\": { endpoint: \"GET /internal/observability_ai_assistant/functions/kb_status\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{ ready: boolean; error?: any; deployment_state?: string | undefined; allocation_state?: string | undefined; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/setup_kb\": { endpoint: \"POST /internal/observability_ai_assistant/functions/setup_kb\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{}>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/summarize\": { endpoint: \"POST /internal/observability_ai_assistant/functions/summarize\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ id: ",
"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",
"<boolean, boolean, unknown>; public: ",
"Type",
"<boolean, boolean, unknown>; labels: ",
"RecordC",
"<",
"StringC",
", ",
"StringC",
">; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { id: string; text: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">; confidence: \"medium\" | \"high\" | \"low\"; is_correction: boolean; public: boolean; labels: { [x: string]: string; }; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/recall\": { endpoint: \"POST /internal/observability_ai_assistant/functions/recall\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ queries: ",
"ArrayC",
"<",
"BrandC",
"<",
"StringC",
", ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">>; }>, ",
"PartialC",
"<{ contexts: ",
"ArrayC",
"<",
"StringC",
">; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { queries: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">[]; } & { contexts?: string[] | undefined; }; }; }) => Promise<{ entries: ",
"RecalledEntry",
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/elasticsearch\": { endpoint: \"POST /internal/observability_ai_assistant/functions/elasticsearch\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ method: ",
"UnionC",
"<[",
"LiteralC",
"<\"GET\">, ",
"LiteralC",
"<\"POST\">, ",
"LiteralC",
"<\"PATCH\">, ",
"LiteralC",
"<\"PUT\">, ",
"LiteralC",
"<\"DELETE\">]>; path: ",
"StringC",
"; }>, ",
"PartialC",
"<{ body: ",
"AnyC",
"; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { method: \"GET\" | \"DELETE\" | \"POST\" | \"PUT\" | \"PATCH\"; path: string; } & { body?: any; }; }; }) => Promise<unknown>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/connectors\": { endpoint: \"GET /internal/observability_ai_assistant/connectors\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.FindConnectorResult",
"text": "FindConnectorResult"
},
"[]>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { title: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ connectorId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { connectorId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationUpdateRequest",
", ",
"ConversationUpdateRequest",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { conversation: ",
"ConversationUpdateRequest",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversation\": { endpoint: \"POST /internal/observability_ai_assistant/conversation\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationRequestBase",
", ",
"ConversationRequestBase",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { conversation: ",
"ConversationRequestBase",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversations\": { endpoint: \"POST /internal/observability_ai_assistant/conversations\"; params?: ",
"PartialC",
"<{ body: ",
"PartialC",
"<{ query: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params?: { body?: { query?: string | undefined; } | undefined; } | undefined; }) => Promise<{ conversations: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"GET /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/chat\": { endpoint: \"POST /internal/observability_ai_assistant/chat\"; params?: ",
"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",
"; functions: ",
"ArrayC",
"<",
"TypeC",
"<{ name: ",
"StringC",
"; description: ",
"StringC",
"; parameters: ",
"AnyC",
"; }>>; }>, ",
"PartialC",
"<{ functionCall: ",
"StringC",
"; }>]>; }>, ",
"PartialC",
"<{ query: ",
"TypeC",
"<{ stream: ",
"Type",
"<boolean, boolean, unknown>; }>; }>]> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { messages: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; connectorId: string; functions: { name: string; description: string; parameters: any; }[]; } & { functionCall?: string | undefined; }; } & { query?: { stream: boolean; } | undefined; }; }) => Promise<",
"IncomingMessage",
" | ",
"CreateChatCompletionResponse",
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; }[TEndpoint] extends { endpoint: any; params?: infer TRouteParamsRT | undefined; handler: ({}: any) => Promise<any>; } & ",
"ServerRouteCreateOptions",
" ? TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" ? ClientRequestParamsOfType<TRouteParamsRT> : {} : never"
],
"path": "x-pack/plugins/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/chat\" | \"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}/auto_title\" | \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\" | \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\" | \"GET /internal/observability_ai_assistant/connectors\" | \"POST /internal/observability_ai_assistant/functions/elasticsearch\" | \"POST /internal/observability_ai_assistant/functions/recall\" | \"POST /internal/observability_ai_assistant/functions/summarize\" | \"POST /internal/observability_ai_assistant/functions/setup_kb\" | \"GET /internal/observability_ai_assistant/functions/kb_status\" | \"POST /internal/observability_ai_assistant/functions/alerts\""
],
"path": "x-pack/plugins/observability_ai_assistant/public/api/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantPluginSetup",
"type": "Interface",
"tags": [],
"label": "ObservabilityAIAssistantPluginSetup",
"description": [],
"path": "x-pack/plugins/observability_ai_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantPluginStart",
"type": "Interface",
"tags": [],
"label": "ObservabilityAIAssistantPluginStart",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "public",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-public.ObservabilityAIAssistantPluginStart",
"text": "ObservabilityAIAssistantPluginStart"
},
" extends ",
"ObservabilityAIAssistantService"
],
"path": "x-pack/plugins/observability_ai_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantPluginStart.register",
"type": "Function",
"tags": [],
"label": "register",
"description": [],
"signature": [
"(fn: ",
"ChatRegistrationFunction",
") => void"
],
"path": "x-pack/plugins/observability_ai_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-public.ObservabilityAIAssistantPluginStart.register.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"ChatRegistrationFunction"
],
"path": "x-pack/plugins/observability_ai_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-server.ObservabilityAIAssistantServerRouteRepository",
"type": "Type",
"tags": [],
"label": "ObservabilityAIAssistantServerRouteRepository",
"description": [],
"signature": [
"{ \"POST /internal/observability_ai_assistant/functions/alerts\": { endpoint: \"POST /internal/observability_ai_assistant/functions/alerts\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ featureIds: ",
"ArrayC",
"<",
"StringC",
">; start: ",
"StringC",
"; end: ",
"StringC",
"; }>, ",
"PartialC",
"<{ filter: ",
"StringC",
"; includeRecovered: ",
"Type",
"<boolean, boolean, unknown>; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { featureIds: string[]; start: string; end: string; } & { filter?: string | undefined; includeRecovered?: boolean | undefined; }; }; }) => Promise<{ content: { total: number; alerts: OutputOf<SetOptional<{ readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>[]; }; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/functions/kb_status\": { endpoint: \"GET /internal/observability_ai_assistant/functions/kb_status\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{ ready: boolean; error?: any; deployment_state?: string | undefined; allocation_state?: string | undefined; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/setup_kb\": { endpoint: \"POST /internal/observability_ai_assistant/functions/setup_kb\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<{}>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/summarize\": { endpoint: \"POST /internal/observability_ai_assistant/functions/summarize\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ id: ",
"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",
"<boolean, boolean, unknown>; public: ",
"Type",
"<boolean, boolean, unknown>; labels: ",
"RecordC",
"<",
"StringC",
", ",
"StringC",
">; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { id: string; text: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">; confidence: \"medium\" | \"high\" | \"low\"; is_correction: boolean; public: boolean; labels: { [x: string]: string; }; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/recall\": { endpoint: \"POST /internal/observability_ai_assistant/functions/recall\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ queries: ",
"ArrayC",
"<",
"BrandC",
"<",
"StringC",
", ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">>; }>, ",
"PartialC",
"<{ contexts: ",
"ArrayC",
"<",
"StringC",
">; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { queries: ",
"Branded",
"<string, ",
{
"pluginId": "@kbn/io-ts-utils",
"scope": "common",
"docId": "kibKbnIoTsUtilsPluginApi",
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">[]; } & { contexts?: string[] | undefined; }; }; }) => Promise<{ entries: ",
"RecalledEntry",
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/functions/elasticsearch\": { endpoint: \"POST /internal/observability_ai_assistant/functions/elasticsearch\"; params?: ",
"TypeC",
"<{ body: ",
"IntersectionC",
"<[",
"TypeC",
"<{ method: ",
"UnionC",
"<[",
"LiteralC",
"<\"GET\">, ",
"LiteralC",
"<\"POST\">, ",
"LiteralC",
"<\"PATCH\">, ",
"LiteralC",
"<\"PUT\">, ",
"LiteralC",
"<\"DELETE\">]>; path: ",
"StringC",
"; }>, ",
"PartialC",
"<{ body: ",
"AnyC",
"; }>]>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { method: \"GET\" | \"DELETE\" | \"POST\" | \"PUT\" | \"PATCH\"; path: string; } & { body?: any; }; }; }) => Promise<unknown>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/connectors\": { endpoint: \"GET /internal/observability_ai_assistant/connectors\"; params?: undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
") => Promise<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.FindConnectorResult",
"text": "FindConnectorResult"
},
"[]>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"DELETE /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<void>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { title: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}/auto_title\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ connectorId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { connectorId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"PUT /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationUpdateRequest",
", ",
"ConversationUpdateRequest",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; body: { conversation: ",
"ConversationUpdateRequest",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversation\": { endpoint: \"POST /internal/observability_ai_assistant/conversation\"; params?: ",
"TypeC",
"<{ body: ",
"TypeC",
"<{ conversation: ",
"Type",
"<",
"ConversationRequestBase",
", ",
"ConversationRequestBase",
", unknown>; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { conversation: ",
"ConversationRequestBase",
"; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/conversations\": { endpoint: \"POST /internal/observability_ai_assistant/conversations\"; params?: ",
"PartialC",
"<{ body: ",
"PartialC",
"<{ query: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params?: { body?: { query?: string | undefined; } | undefined; } | undefined; }) => Promise<{ conversations: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
"[]; }>; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"GET /internal/observability_ai_assistant/conversation/{conversationId}\": { endpoint: \"GET /internal/observability_ai_assistant/conversation/{conversationId}\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ conversationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { path: { conversationId: string; }; }; }) => Promise<",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; \"POST /internal/observability_ai_assistant/chat\": { endpoint: \"POST /internal/observability_ai_assistant/chat\"; params?: ",
"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",
"; functions: ",
"ArrayC",
"<",
"TypeC",
"<{ name: ",
"StringC",
"; description: ",
"StringC",
"; parameters: ",
"AnyC",
"; }>>; }>, ",
"PartialC",
"<{ functionCall: ",
"StringC",
"; }>]>; }>, ",
"PartialC",
"<{ query: ",
"TypeC",
"<{ stream: ",
"Type",
"<boolean, boolean, unknown>; }>; }>]> | undefined; handler: ({}: ",
"ObservabilityAIAssistantRouteHandlerResources",
" & { params: { body: { messages: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; connectorId: string; functions: { name: string; description: string; parameters: any; }[]; } & { functionCall?: string | undefined; }; } & { query?: { stream: boolean; } | undefined; }; }) => Promise<",
"IncomingMessage",
" | ",
"CreateChatCompletionResponse",
">; } & ",
"ObservabilityAIAssistantRouteCreateOptions",
"; }"
],
"path": "x-pack/plugins/observability_ai_assistant/server/routes/get_global_observability_ai_assistant_route_repository.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-common.Conversation",
"type": "Interface",
"tags": [],
"label": "Conversation",
"description": [],
"path": "x-pack/plugins/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/plugins/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; }"
],
"path": "x-pack/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/observability_ai_assistant/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "observabilityAIAssistant",
"id": "def-common.MessageRole",
"type": "Enum",
"tags": [],
"label": "MessageRole",
"description": [],
"path": "x-pack/plugins/observability_ai_assistant/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": []
}
}