[8.x] [Epic] AI Insights + Assistant - Add "Other" option t…

…o the existing OpenAI Connector dropdown list (elastic#8936) (elastic#194831) (elastic#195688) # Backport This will backport the following commits from `main` to `8.x`: - [[Epic] AI Insights + Assistant - Add "Other" option to the existing OpenAI Connector dropdown list (elastic#8936) (elastic#194831)](elastic#194831)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Ievgen Sorokopud <[email protected]>
kibanamachine · Oct 9, 2024 · 0035e94 · 0035e94
1 parent ce302a9
commit 0035e94
Show file tree

Hide file tree

Showing 37 changed files with 915 additions and 32 deletions.
diff --git a/oas_docs/output/kibana.serverless.staging.yaml b/oas_docs/output/kibana.serverless.staging.yaml
@@ -22906,6 +22906,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Security_AI_Assistant_API_Reader:
       additionalProperties: true

diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -22906,6 +22906,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Security_AI_Assistant_API_Reader:
       additionalProperties: true

diff --git a/oas_docs/output/kibana.staging.yaml b/oas_docs/output/kibana.staging.yaml
@@ -30731,6 +30731,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Security_AI_Assistant_API_Reader:
       additionalProperties: true

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -30731,6 +30731,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Security_AI_Assistant_API_Reader:
       additionalProperties: true

diff --git a/...ic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml b/...ic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml
@@ -1194,6 +1194,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Reader:
       additionalProperties: true

diff --git a/...stant-common/docs/openapi/serverless/elastic_assistant_api_2023_10_31.bundled.schema.yaml b/...stant-common/docs/openapi/serverless/elastic_assistant_api_2023_10_31.bundled.schema.yaml
@@ -1194,6 +1194,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
       type: string
     Reader:
       additionalProperties: true

diff --git a/...packages/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.gen.ts b/...packages/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.gen.ts
@@ -46,7 +46,7 @@ export const Reader = z.object({}).catchall(z.unknown());
  * Provider
  */
 export type Provider = z.infer<typeof Provider>;
-export const Provider = z.enum(['OpenAI', 'Azure OpenAI']);
+export const Provider = z.enum(['OpenAI', 'Azure OpenAI', 'Other']);
 export type ProviderEnum = typeof Provider.enum;
 export const ProviderEnum = Provider.enum;
 

diff --git a/...ges/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.schema.yaml b/...ges/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.schema.yaml
@@ -34,6 +34,7 @@ components:
       enum:
         - OpenAI
         - Azure OpenAI
+        - Other
 
     MessageRole:
       type: string

diff --git a/x-pack/packages/kbn-elastic-assistant/impl/connectorland/helpers.tsx b/x-pack/packages/kbn-elastic-assistant/impl/connectorland/helpers.tsx
@@ -18,6 +18,7 @@ import { PRECONFIGURED_CONNECTOR } from './translations';
 enum OpenAiProviderType {
   OpenAi = 'OpenAI',
   AzureAi = 'Azure OpenAI',
+  Other = 'Other',
 }
 
 interface GenAiConfig {

diff --git a/x-pack/plugins/actions/server/usage/actions_telemetry.test.ts b/x-pack/plugins/actions/server/usage/actions_telemetry.test.ts
@@ -1025,15 +1025,17 @@ describe('actions telemetry', () => {
       '.d3security': 2,
       '.gen-ai__Azure OpenAI': 3,
       '.gen-ai__OpenAI': 1,
+      '.gen-ai__Other': 1,
     };
     const { countByType, countGenAiProviderTypes } = getCounts(aggs);
     expect(countByType).toEqual({
       __d3security: 2,
-      '__gen-ai': 4,
+      '__gen-ai': 5,
     });
     expect(countGenAiProviderTypes).toEqual({
       'Azure OpenAI': 3,
       OpenAI: 1,
+      Other: 1,
     });
   });
 });
diff --git a/x-pack/plugins/actions/server/usage/types.ts b/x-pack/plugins/actions/server/usage/types.ts
@@ -51,6 +51,7 @@ export const byGenAiProviderTypeSchema: MakeSchemaFrom<ActionsUsage>['count_by_t
   // Known providers:
   ['Azure OpenAI']: { type: 'long' },
   ['OpenAI']: { type: 'long' },
+  ['Other']: { type: 'long' },
 };
 
 export const byServiceProviderTypeSchema: MakeSchemaFrom<ActionsUsage>['count_active_email_connectors_by_service_type'] =

diff --git a/x-pack/plugins/elastic_assistant/server/routes/utils.test.ts b/x-pack/plugins/elastic_assistant/server/routes/utils.test.ts
@@ -65,5 +65,17 @@ describe('Utils', () => {
       const isOpenModel = isOpenSourceModel(connector);
       expect(isOpenModel).toEqual(true);
     });
+
+    it('should return `true` when apiProvider of OpenAiProviderType.Other is specified', async () => {
+      const connector = {
+        actionTypeId: '.gen-ai',
+        config: {
+          apiUrl: OPENAI_CHAT_URL,
+          apiProvider: OpenAiProviderType.Other,
+        },
+      } as unknown as Connector;
+      const isOpenModel = isOpenSourceModel(connector);
+      expect(isOpenModel).toEqual(true);
+    });
   });
 });
diff --git a/x-pack/plugins/elastic_assistant/server/routes/utils.ts b/x-pack/plugins/elastic_assistant/server/routes/utils.ts
@@ -203,19 +203,25 @@ export const isOpenSourceModel = (connector?: Connector): boolean => {
   }
 
   const llmType = getLlmType(connector.actionTypeId);
-  const connectorApiUrl = connector.config?.apiUrl
-    ? (connector.config.apiUrl as string)
-    : undefined;
+  const isOpenAiType = llmType === 'openai';
+
+  if (!isOpenAiType) {
+    return false;
+  }
   const connectorApiProvider = connector.config?.apiProvider
     ? (connector.config?.apiProvider as OpenAiProviderType)
     : undefined;
+  if (connectorApiProvider === OpenAiProviderType.Other) {
+    return true;
+  }
 
-  const isOpenAiType = llmType === 'openai';
-  const isOpenAI =
-    isOpenAiType &&
-    (!connectorApiUrl ||
-      connectorApiUrl === OPENAI_CHAT_URL ||
-      connectorApiProvider === OpenAiProviderType.AzureAi);
+  const connectorApiUrl = connector.config?.apiUrl
+    ? (connector.config.apiUrl as string)
+    : undefined;
 
-  return isOpenAiType && !isOpenAI;
+  return (
+    !!connectorApiUrl &&
+    connectorApiUrl !== OPENAI_CHAT_URL &&
+    connectorApiProvider !== OpenAiProviderType.AzureAi
+  );
 };
diff --git a/x-pack/plugins/search_playground/common/types.ts b/x-pack/plugins/search_playground/common/types.ts
@@ -57,6 +57,7 @@ export enum APIRoutes {
 export enum LLMs {
   openai = 'openai',
   openai_azure = 'openai_azure',
+  openai_other = 'openai_other',
   bedrock = 'bedrock',
   gemini = 'gemini',
 }

diff --git a/x-pack/plugins/search_playground/public/hooks/use_llms_models.test.ts b/x-pack/plugins/search_playground/public/hooks/use_llms_models.test.ts
@@ -15,9 +15,10 @@ jest.mock('./use_load_connectors', () => ({
 }));
 
 const mockConnectors = [
-  { id: 'connectorId1', title: 'OpenAI Connector', type: LLMs.openai },
-  { id: 'connectorId2', title: 'OpenAI Azure Connector', type: LLMs.openai_azure },
-  { id: 'connectorId2', title: 'Bedrock Connector', type: LLMs.bedrock },
+  { id: 'connectorId1', name: 'OpenAI Connector', type: LLMs.openai },
+  { id: 'connectorId2', name: 'OpenAI Azure Connector', type: LLMs.openai_azure },
+  { id: 'connectorId2', name: 'Bedrock Connector', type: LLMs.bedrock },
+  { id: 'connectorId3', name: 'OpenAI OSS Model Connector', type: LLMs.openai_other },
 ];
 const mockUseLoadConnectors = (data: any) => {
   (useLoadConnectors as jest.Mock).mockReturnValue({ data });
@@ -36,7 +37,7 @@ describe('useLLMsModels Hook', () => {
     expect(result.current).toEqual([
       {
         connectorId: 'connectorId1',
-        connectorName: undefined,
+        connectorName: 'OpenAI Connector',
         connectorType: LLMs.openai,
         disabled: false,
         icon: expect.any(Function),
@@ -48,7 +49,7 @@ describe('useLLMsModels Hook', () => {
       },
       {
         connectorId: 'connectorId1',
-        connectorName: undefined,
+        connectorName: 'OpenAI Connector',
         connectorType: LLMs.openai,
         disabled: false,
         icon: expect.any(Function),
@@ -60,7 +61,7 @@ describe('useLLMsModels Hook', () => {
       },
       {
         connectorId: 'connectorId1',
-        connectorName: undefined,
+        connectorName: 'OpenAI Connector',
         connectorType: LLMs.openai,
         disabled: false,
         icon: expect.any(Function),
@@ -72,19 +73,19 @@ describe('useLLMsModels Hook', () => {
       },
       {
         connectorId: 'connectorId2',
-        connectorName: undefined,
+        connectorName: 'OpenAI Azure Connector',
         connectorType: LLMs.openai_azure,
         disabled: false,
         icon: expect.any(Function),
-        id: 'connectorId2Azure OpenAI ',
-        name: 'Azure OpenAI ',
+        id: 'connectorId2OpenAI Azure Connector (Azure OpenAI)',
+        name: 'OpenAI Azure Connector (Azure OpenAI)',
         showConnectorName: false,
         value: undefined,
         promptTokenLimit: undefined,
       },
       {
         connectorId: 'connectorId2',
-        connectorName: undefined,
+        connectorName: 'Bedrock Connector',
         connectorType: LLMs.bedrock,
         disabled: false,
         icon: expect.any(Function),
@@ -96,7 +97,7 @@ describe('useLLMsModels Hook', () => {
       },
       {
         connectorId: 'connectorId2',
-        connectorName: undefined,
+        connectorName: 'Bedrock Connector',
         connectorType: LLMs.bedrock,
         disabled: false,
         icon: expect.any(Function),
@@ -106,6 +107,18 @@ describe('useLLMsModels Hook', () => {
         value: 'anthropic.claude-3-5-sonnet-20240620-v1:0',
         promptTokenLimit: 200000,
       },
+      {
+        connectorId: 'connectorId3',
+        connectorName: 'OpenAI OSS Model Connector',
+        connectorType: LLMs.openai_other,
+        disabled: false,
+        icon: expect.any(Function),
+        id: 'connectorId3OpenAI OSS Model Connector (OpenAI Compatible Service)',
+        name: 'OpenAI OSS Model Connector (OpenAI Compatible Service)',
+        showConnectorName: false,
+        value: undefined,
+        promptTokenLimit: undefined,
+      },
     ]);
   });
 

diff --git a/x-pack/plugins/search_playground/public/hooks/use_llms_models.ts b/x-pack/plugins/search_playground/public/hooks/use_llms_models.ts
@@ -34,11 +34,22 @@ const mapLlmToModels: Record<
   },
   [LLMs.openai_azure]: {
     icon: OpenAILogo,
-    getModels: (connectorName, includeName) => [
+    getModels: (connectorName) => [
       {
         label: i18n.translate('xpack.searchPlayground.openAIAzureModel', {
-          defaultMessage: 'Azure OpenAI {name}',
-          values: { name: includeName ? `(${connectorName})` : '' },
+          defaultMessage: '{name} (Azure OpenAI)',
+          values: { name: connectorName },
+        }),
+      },
+    ],
+  },
+  [LLMs.openai_other]: {
+    icon: OpenAILogo,
+    getModels: (connectorName) => [
+      {
+        label: i18n.translate('xpack.searchPlayground.otherOpenAIModel', {
+          defaultMessage: '{name} (OpenAI Compatible Service)',
+          values: { name: connectorName },
         }),
       },
     ],

diff --git a/x-pack/plugins/search_playground/public/hooks/use_load_connectors.test.ts b/x-pack/plugins/search_playground/public/hooks/use_load_connectors.test.ts
@@ -71,6 +71,12 @@ describe('useLoadConnectors', () => {
         actionTypeId: '.bedrock',
         isMissingSecrets: false,
       },
+      {
+        id: '5',
+        actionTypeId: '.gen-ai',
+        isMissingSecrets: false,
+        config: { apiProvider: OpenAiProviderType.Other },
+      },
     ];
     mockedLoadConnectors.mockResolvedValue(connectors);
 
@@ -106,6 +112,16 @@ describe('useLoadConnectors', () => {
           title: 'Bedrock',
           type: 'bedrock',
         },
+        {
+          actionTypeId: '.gen-ai',
+          config: {
+            apiProvider: 'Other',
+          },
+          id: '5',
+          isMissingSecrets: false,
+          title: 'OpenAI Other',
+          type: 'openai_other',
+        },
       ]);
     });
   });

diff --git a/x-pack/plugins/search_playground/public/hooks/use_load_connectors.ts b/x-pack/plugins/search_playground/public/hooks/use_load_connectors.ts
@@ -63,6 +63,20 @@ const connectorTypeToLLM: Array<{
       type: LLMs.openai,
     }),
   },
+  {
+    actionId: OPENAI_CONNECTOR_ID,
+    actionProvider: OpenAiProviderType.Other,
+    match: (connector) =>
+      connector.actionTypeId === OPENAI_CONNECTOR_ID &&
+      (connector as OpenAIConnector)?.config?.apiProvider === OpenAiProviderType.Other,
+    transform: (connector) => ({
+      ...connector,
+      title: i18n.translate('xpack.searchPlayground.openAIOtherConnectorTitle', {
+        defaultMessage: 'OpenAI Other',
+      }),
+      type: LLMs.openai_other,
+    }),
+  },
   {
     actionId: BEDROCK_CONNECTOR_ID,
     match: (connector) => connector.actionTypeId === BEDROCK_CONNECTOR_ID,

diff --git a/x-pack/plugins/search_playground/server/lib/get_chat_params.test.ts b/x-pack/plugins/search_playground/server/lib/get_chat_params.test.ts
@@ -152,4 +152,41 @@ describe('getChatParams', () => {
       )
     ).rejects.toThrow('Invalid connector id');
   });
+
+  it('returns the correct chat model and uses the default model when not specified in the params', async () => {
+    mockActionsClient.get.mockResolvedValue({
+      id: '2',
+      actionTypeId: OPENAI_CONNECTOR_ID,
+      config: { defaultModel: 'local' },
+    });
+
+    const result = await getChatParams(
+      {
+        connectorId: '2',
+        prompt: 'How does it work?',
+        citations: false,
+      },
+      { actions, request, logger }
+    );
+
+    expect(Prompt).toHaveBeenCalledWith('How does it work?', {
+      citations: false,
+      context: true,
+      type: 'openai',
+    });
+    expect(QuestionRewritePrompt).toHaveBeenCalledWith({
+      type: 'openai',
+    });
+    expect(ActionsClientChatOpenAI).toHaveBeenCalledWith({
+      logger: expect.anything(),
+      model: 'local',
+      connectorId: '2',
+      actionsClient: expect.anything(),
+      signal: expect.anything(),
+      traceId: 'test-uuid',
+      temperature: 0.2,
+      maxRetries: 0,
+    });
+    expect(result.chatPrompt).toContain('How does it work?');
+  });
 });
diff --git a/x-pack/plugins/search_playground/server/lib/get_chat_params.ts b/x-pack/plugins/search_playground/server/lib/get_chat_params.ts
@@ -57,7 +57,7 @@ export const getChatParams = async (
         actionsClient,
         logger,
         connectorId,
-        model,
+        model: model || connector?.config?.defaultModel,
         traceId: uuidv4(),
         signal: abortSignal,
         temperature: getDefaultArguments().temperature,

diff --git a/x-pack/plugins/security_solution/public/attack_discovery/use_attack_discovery/helpers.ts b/x-pack/plugins/security_solution/public/attack_discovery/use_attack_discovery/helpers.ts
@@ -18,6 +18,7 @@ import { isEmpty } from 'lodash/fp';
 enum OpenAiProviderType {
   OpenAi = 'OpenAI',
   AzureAi = 'Azure OpenAI',
+  Other = 'Other',
 }
 
 interface GenAiConfig {

diff --git a/x-pack/plugins/stack_connectors/common/openai/constants.ts b/x-pack/plugins/stack_connectors/common/openai/constants.ts
@@ -27,6 +27,7 @@ export enum SUB_ACTION {
 export enum OpenAiProviderType {
   OpenAi = 'OpenAI',
   AzureAi = 'Azure OpenAI',
+  Other = 'Other',
 }
 
 export const DEFAULT_TIMEOUT_MS = 120000;
-Original file line number
+Diff line change
@@ Expand Up / @@ -1194,6 +1194,7 @@ components: @@
           enum:
             - OpenAI
             - Azure OpenAI
+            - Other
           type: string
         Reader:
           additionalProperties: true
@@ Expand Down @@