[8.16] [AI Assistant] Set scope and rename to Observability and Search (

#196322) (#197608) # Backport This will backport the following commits from `main` to `8.16`: - [[AI Assistant] Set scope and rename to Observability and Search (#196322)](#196322)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Sander Philipse <[email protected]>
elastic · Oct 28, 2024 · dedfdec · dedfdec
1 parent 9702676
commit dedfdec
Show file tree

Hide file tree

Showing 74 changed files with 523 additions and 518 deletions.
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -744,7 +744,7 @@ Elastic.
 
 
 |{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/observability_ai_assistant_management/README.md[observabilityAiAssistantManagement]
-|The observabilityAiAssistantManagement plugin manages the Ai Assistant for Observability management section.
+|The observabilityAiAssistantManagement plugin manages the Ai Assistant for Observability and Search management section.
 
 
 |{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/observability_logs_explorer/README.md[observabilityLogsExplorer]

diff --git a/...i_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx b/...i_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx
@@ -139,7 +139,7 @@ export function AiAssistantSelectionPage() {
             isDisabled={!observabilityAIAssistantEnabled}
             title={i18n.translate(
               'aiAssistantManagementSelection.aiAssistantSelectionPage.observabilityLabel',
-              { defaultMessage: 'Elastic AI Assistant for Observability' }
+              { defaultMessage: 'Elastic AI Assistant for Observability and Search' }
             )}
             titleSize="xs"
           />

diff --git a/src/plugins/ai_assistant_management/selection/server/plugin.ts b/src/plugins/ai_assistant_management/selection/server/plugin.ts
@@ -50,15 +50,15 @@ export class AIAssistantManagementSelectionPlugin
     core.uiSettings.register({
       [PREFERRED_AI_ASSISTANT_TYPE_SETTING_KEY]: {
         name: i18n.translate('aiAssistantManagementSelection.preferredAIAssistantTypeSettingName', {
-          defaultMessage: 'Observability AI Assistant scope',
+          defaultMessage: 'AI Assistant for Observability and Search visibility',
         }),
         category: [DEFAULT_APP_CATEGORIES.observability.id],
         value: this.config.preferredAIAssistantType,
         description: i18n.translate(
           'aiAssistantManagementSelection.preferredAIAssistantTypeSettingDescription',
           {
             defaultMessage:
-              '<em>[technical preview]</em> Whether to show the Observability AI Assistant menu item in Observability, everywhere, or nowhere.',
+              '<em>[technical preview]</em> Whether to show the AI Assistant menu item in Observability and Search, everywhere, or nowhere.',
             values: {
               em: (chunks) => `<em>${chunks}</em>`,
             },
@@ -77,7 +77,7 @@ export class AIAssistantManagementSelectionPlugin
         optionLabels: {
           [AIAssistantType.Default]: i18n.translate(
             'aiAssistantManagementSelection.preferredAIAssistantTypeSettingValueDefault',
-            { defaultMessage: 'Observability only (default)' }
+            { defaultMessage: 'Observability and Search only (default)' }
           ),
           [AIAssistantType.Observability]: i18n.translate(
             'aiAssistantManagementSelection.preferredAIAssistantTypeSettingValueObservability',

diff --git a/x-pack/packages/kbn-ai-assistant-common/src/utils/filter_scopes.ts b/x-pack/packages/kbn-ai-assistant-common/src/utils/filter_scopes.ts
@@ -7,11 +7,15 @@
 
 import type { AssistantScope } from '../types';
 
-export function filterScopes<T extends { scopes?: AssistantScope[] }>(scope?: AssistantScope) {
+export function filterScopes<T extends { scopes?: AssistantScope[] }>(
+  scopeFilters?: AssistantScope[]
+) {
   return function (value: T): boolean {
-    if (!scope || !value) {
+    if (!scopeFilters || !value) {
       return true;
     }
-    return value?.scopes ? value.scopes.includes(scope) || value.scopes.includes('all') : true;
+    return value?.scopes
+      ? value.scopes.some((scope) => [...scopeFilters, 'all'].includes(scope))
+      : true;
   };
 }
diff --git a/x-pack/packages/kbn-ai-assistant/src/conversation/conversation_view.tsx b/x-pack/packages/kbn-ai-assistant/src/conversation/conversation_view.tsx
@@ -10,6 +10,7 @@ import { euiThemeVars } from '@kbn/ui-theme';
 import React, { useEffect, useState } from 'react';
 import ReactDOM from 'react-dom';
 import type { AssistantScope } from '@kbn/ai-assistant-common';
+import { isEqual } from 'lodash';
 import { useKibana } from '../hooks/use_kibana';
 import { ConversationList, ChatBody, ChatInlineEditingContent } from '../chat';
 import { useConversationKey } from '../hooks/use_conversation_key';
@@ -27,15 +28,15 @@ interface ConversationViewProps {
   navigateToConversation: (nextConversationId?: string) => void;
   getConversationHref?: (conversationId: string) => string;
   newConversationHref?: string;
-  scope?: AssistantScope;
+  scopes?: AssistantScope[];
 }
 
 export const ConversationView: React.FC<ConversationViewProps> = ({
   conversationId,
   navigateToConversation,
   getConversationHref,
   newConversationHref,
-  scope,
+  scopes,
 }) => {
   const { euiTheme } = useEuiTheme();
 
@@ -61,10 +62,10 @@ export const ConversationView: React.FC<ConversationViewProps> = ({
   );
 
   useEffect(() => {
-    if (scope) {
-      service.setScope(scope);
+    if (scopes && !isEqual(scopes, service.getScopes())) {
+      service.setScopes(scopes);
     }
-  }, [scope, service]);
+  }, [scopes, service]);
 
   const { key: bodyKey, updateConversationIdInPlace } = useConversationKey(conversationId);
 

diff --git a/x-pack/packages/kbn-ai-assistant/src/hooks/__storybook_mocks__/use_conversation.ts b/x-pack/packages/kbn-ai-assistant/src/hooks/__storybook_mocks__/use_conversation.ts
@@ -15,6 +15,6 @@ export function useConversation() {
     stop: () => {},
     messages: [],
     saveTitle: () => {},
-    scope: 'all',
+    scopes: ['all'],
   };
 }
diff --git a/x-pack/packages/kbn-ai-assistant/src/hooks/index.ts b/x-pack/packages/kbn-ai-assistant/src/hooks/index.ts
@@ -8,4 +8,4 @@
 export * from './use_ai_assistant_app_service';
 export * from './use_ai_assistant_chat_service';
 export * from './use_knowledge_base';
-export * from './use_scope';
+export * from './use_scopes';
diff --git a/x-pack/packages/kbn-ai-assistant/src/hooks/use_conversation.test.tsx b/x-pack/packages/kbn-ai-assistant/src/hooks/use_conversation.test.tsx
@@ -55,9 +55,9 @@ const mockService: MockedService = {
     predefinedConversation$: new Observable(),
   },
   navigate: jest.fn().mockReturnValue(of()),
-  scope$: new BehaviorSubject<AssistantScope>('all') as MockedService['scope$'],
-  setScope: jest.fn(),
-  getScope: jest.fn(),
+  scope$: new BehaviorSubject<AssistantScope[]>(['all']) as MockedService['scope$'],
+  setScopes: jest.fn(),
+  getScopes: jest.fn(),
 };
 
 const mockChatService = createMockChatService();

diff --git a/x-pack/packages/kbn-ai-assistant/src/hooks/use_conversation.ts b/x-pack/packages/kbn-ai-assistant/src/hooks/use_conversation.ts
@@ -20,7 +20,7 @@ import { useAIAssistantAppService } from './use_ai_assistant_app_service';
 import { useKibana } from './use_kibana';
 import { useOnce } from './use_once';
 import { useAbortableAsync } from './use_abortable_async';
-import { useScope } from './use_scope';
+import { useScopes } from './use_scopes';
 
 function createNewConversation({
   title = EMPTY_CONVERSATION_TITLE,
@@ -62,7 +62,7 @@ export function useConversation({
   onConversationUpdate,
 }: UseConversationProps): UseConversationResult {
   const service = useAIAssistantAppService();
-  const scope = useScope();
+  const scopes = useScopes();
 
   const {
     services: {
@@ -122,7 +122,7 @@ export function useConversation({
       onConversationUpdate?.({ conversation: event.conversation });
     },
     persist: true,
-    scope,
+    scopes,
   });
 
   const [displayedConversationId, setDisplayedConversationId] = useState(initialConversationId);

diff --git a/...s/kbn-ai-assistant/src/hooks/use_scope.ts → .../kbn-ai-assistant/src/hooks/use_scopes.ts b/...s/kbn-ai-assistant/src/hooks/use_scope.ts → .../kbn-ai-assistant/src/hooks/use_scopes.ts
@@ -8,8 +8,8 @@
 import { useObservable } from 'react-use/lib';
 import { useAIAssistantAppService } from './use_ai_assistant_app_service';
 
-export const useScope = () => {
+export const useScopes = () => {
   const service = useAIAssistantAppService();
-  const scope = useObservable(service.scope$);
-  return scope || 'all';
+  const scopes = useObservable(service.scope$);
+  return scopes || ['all'];
 };
diff --git a/x-pack/packages/kbn-ai-assistant/src/utils/create_mock_chat_service.ts b/x-pack/packages/kbn-ai-assistant/src/utils/create_mock_chat_service.ts
@@ -32,7 +32,7 @@ export const createMockChatService = (): MockedChatService => {
         content: '',
       },
     }),
-    getScope: jest.fn(),
+    getScopes: jest.fn(),
   };
   return mockChatService;
 };
diff --git a/x-pack/plugins/observability_solution/apm/server/assistant_functions/get_apm_dataset_info.ts b/x-pack/plugins/observability_solution/apm/server/assistant_functions/get_apm_dataset_info.ts
@@ -164,7 +164,6 @@ export function registerGetApmDatasetInfoFunction({
           `,
         },
       };
-    },
-    ['observability']
+    }
   );
 }
diff --git a/.../observability_solution/apm/server/assistant_functions/get_apm_downstream_dependencies.ts b/.../observability_solution/apm/server/assistant_functions/get_apm_downstream_dependencies.ts
@@ -67,7 +67,6 @@ export function registerGetApmDownstreamDependenciesFunction({
           randomSampler,
         }),
       };
-    },
-    ['observability']
+    }
   );
 }
diff --git a/...ck/plugins/observability_solution/apm/server/assistant_functions/get_apm_services_list.ts b/...ck/plugins/observability_solution/apm/server/assistant_functions/get_apm_services_list.ts
@@ -84,7 +84,6 @@ export function registerGetApmServicesListFunction({
           arguments: args,
         }),
       };
-    },
-    ['observability']
+    }
   );
 }
diff --git a/x-pack/plugins/observability_solution/apm/server/assistant_functions/get_apm_timeseries.ts b/x-pack/plugins/observability_solution/apm/server/assistant_functions/get_apm_timeseries.ts
@@ -138,8 +138,7 @@ export function registerGetApmTimeseriesFunction({
         content: timeseries.map((series): Omit<ApmTimeseries, 'data'> => omit(series, 'data')),
         data: timeseries,
       };
-    },
-    ['observability']
+    }
   );
 }
 

diff --git a/x-pack/plugins/observability_solution/apm/server/assistant_functions/index.ts b/x-pack/plugins/observability_solution/apm/server/assistant_functions/index.ts
@@ -49,7 +49,10 @@ export function registerAssistantFunctions({
   ruleDataClient: IRuleDataClient;
   plugins: APMRouteHandlerResources['plugins'];
 }): RegistrationCallback {
-  return async ({ resources, functions: { registerFunction } }) => {
+  return async ({ resources, functions: { registerFunction }, scopes }) => {
+    if (!scopes.includes('observability')) {
+      return;
+    }
     const apmRouteHandlerResources: MinimalAPMRouteHandlerResources = {
       context: resources.context,
       request: resources.request,

diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/common/functions/types.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/common/functions/types.ts
@@ -6,7 +6,6 @@
  */
 import type { JSONSchema7TypeName } from 'json-schema';
 import type { Observable } from 'rxjs';
-import type { AssistantScope } from '@kbn/ai-assistant-common';
 import { ChatCompletionChunkEvent, MessageAddEvent } from '../conversation_complete';
 import { FunctionVisibility } from './function_visibility';
 export { FunctionVisibility };
@@ -42,7 +41,6 @@ export interface FunctionDefinition<TParameters extends CompatibleJSONSchema = a
   visibility?: FunctionVisibility;
   descriptionForUser?: string;
   parameters?: TParameters;
-  scopes?: AssistantScope[];
 }
 
 export type FunctionRegistry = Map<string, FunctionDefinition>;
diff --git a/...s/observability_solution/observability_ai_assistant/public/components/insight/insight.tsx b/...s/observability_solution/observability_ai_assistant/public/components/insight/insight.tsx
@@ -56,7 +56,7 @@ function ChatContent({
 }) {
   const service = useObservabilityAIAssistant();
   const chatService = useObservabilityAIAssistantChatService();
-  const scope = chatService.getScope();
+  const scopes = chatService.getScopes();
 
   const initialMessagesRef = useRef(initialMessages);
 
@@ -69,7 +69,7 @@ function ChatContent({
     initialMessages,
     persist: false,
     disableFunctions: true,
-    scope,
+    scopes,
   });
 
   const lastAssistantResponse = getLastMessageOfType(

diff --git a/...k/plugins/observability_solution/observability_ai_assistant/public/hooks/use_chat.test.ts b/...k/plugins/observability_solution/observability_ai_assistant/public/hooks/use_chat.test.ts
@@ -39,7 +39,7 @@ const mockChatService: MockedChatService = {
       role: MessageRole.System,
     },
   }),
-  getScope: jest.fn(),
+  getScopes: jest.fn(),
 };
 
 const addErrorMock = jest.fn();
@@ -83,7 +83,7 @@ describe('useChat', () => {
           service: {
             getScreenContexts: () => [],
           } as unknown as ObservabilityAIAssistantService,
-          scope: 'observability',
+          scopes: ['observability'],
         } as UseChatProps,
       });
     });
@@ -113,7 +113,7 @@ describe('useChat', () => {
           service: {
             getScreenContexts: () => [],
           } as unknown as ObservabilityAIAssistantService,
-          scope: 'observability',
+          scopes: ['observability'],
         } as UseChatProps,
       });
 

diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/hooks/use_chat.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/public/hooks/use_chat.ts
@@ -56,7 +56,7 @@ interface UseChatPropsWithoutContext {
   disableFunctions?: boolean;
   onConversationUpdate?: (event: ConversationCreateEvent | ConversationUpdateEvent) => void;
   onChatComplete?: (messages: Message[]) => void;
-  scope: AssistantScope;
+  scopes: AssistantScope[];
 }
 
 export type UseChatProps = Omit<UseChatPropsWithoutContext, 'notifications'>;
@@ -72,7 +72,7 @@ function useChatWithoutContext({
   onChatComplete,
   persist,
   disableFunctions,
-  scope,
+  scopes,
 }: UseChatPropsWithoutContext): UseChatResult {
   const [chatState, setChatState] = useState(ChatState.Ready);
   const systemMessage = useMemo(() => {
@@ -165,7 +165,7 @@ function useChatWithoutContext({
         disableFunctions: disableFunctions ?? false,
         signal: abortControllerRef.current.signal,
         conversationId,
-        scope,
+        scopes,
       });
 
       function getPendingMessages() {
@@ -264,7 +264,7 @@ function useChatWithoutContext({
       disableFunctions,
       service,
       systemMessage,
-      scope,
+      scopes,
     ]
   );
 

diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/mock.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant/public/mock.tsx
@@ -47,7 +47,7 @@ export const mockChatService: ObservabilityAIAssistantChatService = {
       content: 'System',
     },
   }),
-  getScope: jest.fn(),
+  getScopes: jest.fn(),
 };
 
 export const mockService: ObservabilityAIAssistantService = {
@@ -64,9 +64,9 @@ export const mockService: ObservabilityAIAssistantService = {
     predefinedConversation$: new Observable(),
   },
   navigate: async () => of(),
-  setScope: jest.fn(),
-  getScope: jest.fn(),
-  scope$: new BehaviorSubject<AssistantScope>('all'),
+  setScopes: jest.fn(),
+  getScopes: jest.fn(),
+  scope$: new BehaviorSubject<AssistantScope[]>(['all']),
 };
 
 function createSetupContract(): ObservabilityAIAssistantPublicSetup {

diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/plugin.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant/public/plugin.tsx
@@ -67,7 +67,7 @@ export class ObservabilityAIAssistantPlugin
         coreStart.application.capabilities.observabilityAIAssistant[
           aiAssistantCapabilities.show
         ] === true,
-      scope: this.scopeFromConfig || 'observability',
+      scopes: this.scopeFromConfig ? [this.scopeFromConfig] : ['all'],
       scopeIsMutable: !!this.scopeFromConfig,
     }));
 

diff --git a/...plugins/observability_solution/observability_ai_assistant/public/service/complete.test.ts b/...plugins/observability_solution/observability_ai_assistant/public/service/complete.test.ts
@@ -102,7 +102,7 @@ describe('complete', () => {
         disableFunctions: false,
         signal: new AbortController().signal,
         ...params,
-        scope: 'all',
+        scopes: ['all'],
       },
       requestCallback
     );

diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/complete.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/complete.ts
@@ -43,7 +43,7 @@ export function complete(
     disableFunctions,
     signal,
     instructions,
-    scope,
+    scopes,
   }: {
     client: Pick<ObservabilityAIAssistantChatService, 'chat' | 'complete'>;
     getScreenContexts: () => ObservabilityAIAssistantScreenContext[];
@@ -66,7 +66,7 @@ export function complete(
           screenContexts,
           conversationId,
           instructions,
-          scope,
+          scopes,
         },
       },
     }).pipe(shareReplay());
@@ -133,7 +133,7 @@ export function complete(
               persist,
               disableFunctions,
               instructions,
-              scope,
+              scopes,
             },
             requestCallback
           ).subscribe(subscriber);
-Original file line number
+Diff line change
@@ Expand Up / @@ -164,7 +164,6 @@ export function registerGetApmDatasetInfoFunction({ @@
               `,
             },
           };
-        },
-        ['observability']
+        }
       );
     }