[Security Assistant] Automatically Install Knowledge Base

x-pack/packages/kbn-elastic-assistant-common/constants.ts

@@ -8,6 +8,7 @@
 export const ELASTIC_AI_ASSISTANT_INTERNAL_API_VERSION = '1';
 
 export const ELASTIC_AI_ASSISTANT_URL = '/api/elastic_assistant';
+export const ELASTIC_AI_ASSISTANT_INTERNAL_URL = '/internal/elastic_assistant';
 
 export const ELASTIC_AI_ASSISTANT_CONVERSATIONS_URL = `${ELASTIC_AI_ASSISTANT_URL}/current_user/conversations`;
 export const ELASTIC_AI_ASSISTANT_CONVERSATIONS_URL_BY_ID = `${ELASTIC_AI_ASSISTANT_CONVERSATIONS_URL}/{id}`;
@@ -23,3 +24,8 @@ export const ELASTIC_AI_ASSISTANT_PROMPTS_URL_FIND = `${ELASTIC_AI_ASSISTANT_PRO
 export const ELASTIC_AI_ASSISTANT_ANONYMIZATION_FIELDS_URL = `${ELASTIC_AI_ASSISTANT_URL}/anonymization_fields`;
 export const ELASTIC_AI_ASSISTANT_ANONYMIZATION_FIELDS_URL_BULK_ACTION = `${ELASTIC_AI_ASSISTANT_ANONYMIZATION_FIELDS_URL}/_bulk_action`;
 export const ELASTIC_AI_ASSISTANT_ANONYMIZATION_FIELDS_URL_FIND = `${ELASTIC_AI_ASSISTANT_ANONYMIZATION_FIELDS_URL}/_find`;
+
+// TODO: Update existing 'status' endpoint to take resource as query param as to not conflict with 'entries'
+export const ELASTIC_AI_ASSISTANT_KNOWLEDGE_BASE_URL = `${ELASTIC_AI_ASSISTANT_INTERNAL_URL}/knowledge_base/{resource?}`;
+export const ELASTIC_AI_ASSISTANT_KNOWLEDGE_BASE_ENTRIES_URL = `${ELASTIC_AI_ASSISTANT_URL}/knowledge_base/entries`;
+export const ELASTIC_AI_ASSISTANT_KNOWLEDGE_BASE_ENTRIES_URL_BULK_ACTION = `${ELASTIC_AI_ASSISTANT_URL}/knowledge_base/_bulk_action`;

x-pack/packages/kbn-elastic-assistant-common/impl/capabilities/index.ts

@@ -14,5 +14,6 @@ export type AssistantFeatures = { [K in keyof typeof defaultAssistantFeatures]:
  * Default features available to the elastic assistant
  */
 export const defaultAssistantFeatures = Object.freeze({
+  assistantKnowledgeBaseByDefault: false,
   assistantModelEvaluation: false,
 });

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.gen.ts

@@ -16,7 +16,8 @@ import { z } from 'zod';
  *   version: 1
  */
 
-import { UUID, Replacements } from '../conversations/common_attributes.gen';
+import { NonEmptyString } from '../common_attributes.gen';
+import { Replacements } from '../conversations/common_attributes.gen';
 
 export type ExecuteConnectorRequestParams = z.infer<typeof ExecuteConnectorRequestParams>;
 export const ExecuteConnectorRequestParams = z.object({
@@ -29,7 +30,7 @@ export type ExecuteConnectorRequestParamsInput = z.input<typeof ExecuteConnector
 
 export type ExecuteConnectorRequestBody = z.infer<typeof ExecuteConnectorRequestBody>;
 export const ExecuteConnectorRequestBody = z.object({
-  conversationId: UUID.optional(),
+  conversationId: NonEmptyString.optional(),
   message: z.string().optional(),
   model: z.string().optional(),
   subAction: z.enum(['invokeAI', 'invokeStream']),

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.schema.yaml

@@ -31,7 +31,7 @@ paths:
                 - subAction
               properties:
                 conversationId:
-                  $ref: '../conversations/common_attributes.schema.yaml#/components/schemas/UUID'
+                  $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
                 message:
                   type: string
                 model:

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/anonymization_fields/bulk_crud_anonymization_fields_route.gen.ts

@@ -16,7 +16,7 @@ import { z } from 'zod';
  *   version: 2023-10-31
  */
 
-import { UUID, NonEmptyString } from '../conversations/common_attributes.gen';
+import { NonEmptyString } from '../common_attributes.gen';
 
 export type BulkActionSkipReason = z.infer<typeof BulkActionSkipReason>;
 export const BulkActionSkipReason = z.literal('ANONYMIZATION_FIELD_NOT_MODIFIED');
@@ -44,7 +44,7 @@ export const NormalizedAnonymizationFieldError = z.object({
 
 export type AnonymizationFieldResponse = z.infer<typeof AnonymizationFieldResponse>;
 export const AnonymizationFieldResponse = z.object({
-  id: UUID,
+  id: NonEmptyString,
   timestamp: NonEmptyString.optional(),
   field: z.string(),
   allowed: z.boolean().optional(),

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/anonymization_fields/bulk_crud_anonymization_fields_route.schema.yaml

@@ -103,9 +103,9 @@ components:
         - field
       properties:
         id:
-          $ref: '../conversations/common_attributes.schema.yaml#/components/schemas/UUID'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         'timestamp':
-          $ref: '../conversations/common_attributes.schema.yaml#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         field:
           type: string
         allowed:
@@ -232,4 +232,3 @@ components:
           type: boolean
         anonymized:
           type: boolean
-

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/capabilities/get_capabilities_route.gen.ts

@@ -18,5 +18,6 @@ import { z } from 'zod';
 
 export type GetCapabilitiesResponse = z.infer<typeof GetCapabilitiesResponse>;
 export const GetCapabilitiesResponse = z.object({
+  assistantKnowledgeBaseByDefault: z.boolean(),
   assistantModelEvaluation: z.boolean(),
 });

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/capabilities/get_capabilities_route.schema.yaml

@@ -19,9 +19,12 @@ paths:
               schema:
                 type: object
                 properties:
+                  assistantKnowledgeBaseByDefault:
+                    type: boolean
                   assistantModelEvaluation:
                     type: boolean
                 required:
+                  - assistantKnowledgeBaseByDefault
                   - assistantModelEvaluation
         '400':
           description: Generic Error

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/common_attributes.gen.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { z } from 'zod';
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Common Elastic AI Assistant Attributes
+ *   version: not applicable
+ */
+
+/**
+ * A string that is not empty and does not contain only whitespace
+ */
+export type NonEmptyString = z.infer<typeof NonEmptyString>;
+export const NonEmptyString = z
+  .string()
+  .min(1)
+  .regex(/^(?! *$).+$/);
+
+/**
+ * A universally unique identifier
+ */
+export type UUID = z.infer<typeof UUID>;
+export const UUID = z.string().uuid();
+
+/**
+ * Could be any string, not necessarily a UUID
+ */
+export type User = z.infer<typeof User>;
+export const User = z.object({
+  /**
+   * User id
+   */
+  id: z.string().optional(),
+  /**
+   * User name
+   */
+  name: z.string().optional(),
+});

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/common_attributes.schema.yaml

@@ -0,0 +1,30 @@
+openapi: 3.0.0
+info:
+  title: Common Elastic AI Assistant Attributes
+  version: 'not applicable'
+paths: {}
+components:
+  x-codegen-enabled: true
+  schemas:
+    NonEmptyString:
+      type: string
+      pattern: ^(?! *$).+$
+      minLength: 1
+      description: A string that is not empty and does not contain only whitespace
+
+    UUID:
+      type: string
+      format: uuid
+      description: A universally unique identifier
+
+    User:
+      type: object
+      description: Could be any string, not necessarily a UUID
+      properties:
+        id:
+          type: string
+          description: User id
+        name:
+          type: string
+          description: User name
+

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.gen.ts

@@ -16,35 +16,7 @@ import { z } from 'zod';
  *   version: not applicable
  */
 
-/**
- * A string that is not empty and does not contain only whitespace
- */
-export type NonEmptyString = z.infer<typeof NonEmptyString>;
-export const NonEmptyString = z
-  .string()
-  .min(1)
-  .regex(/^(?! *$).+$/);
-
-/**
- * A universally unique identifier
- */
-export type UUID = z.infer<typeof UUID>;
-export const UUID = z.string().uuid();
-
-/**
- * Could be any string, not necessarily a UUID
- */
-export type User = z.infer<typeof User>;
-export const User = z.object({
-  /**
-   * User id.
-   */
-  id: z.string().optional(),
-  /**
-   * User name.
-   */
-  name: z.string().optional(),
-});
+import { NonEmptyString, User } from '../common_attributes.gen';
 
 /**
  * trace Data
@@ -180,7 +152,7 @@ export const ConversationSummary = z.object({
 export type ErrorSchema = z.infer<typeof ErrorSchema>;
 export const ErrorSchema = z
   .object({
-    id: UUID.optional(),
+    id: NonEmptyString.optional(),
     error: z.object({
       status_code: z.number().int().min(400),
       message: z.string(),
@@ -190,7 +162,7 @@ export const ErrorSchema = z
 
 export type ConversationResponse = z.infer<typeof ConversationResponse>;
 export const ConversationResponse = z.object({
-  id: z.union([UUID, NonEmptyString]),
+  id: NonEmptyString,
   /**
    * The conversation title.
    */
@@ -235,7 +207,7 @@ export const ConversationResponse = z.object({
 
 export type ConversationUpdateProps = z.infer<typeof ConversationUpdateProps>;
 export const ConversationUpdateProps = z.object({
-  id: z.union([UUID, NonEmptyString]),
+  id: NonEmptyString,
   /**
    * The conversation title.
    */

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.schema.yaml

@@ -6,27 +6,6 @@ paths: {}
 components:
   x-codegen-enabled: true
   schemas:
-    NonEmptyString:
-      type: string
-      pattern: ^(?! *$).+$
-      minLength: 1
-      description: A string that is not empty and does not contain only whitespace
-
-    UUID:
-      type: string
-      format: uuid
-      description: A universally unique identifier
-
-    User:
-      type: object
-      description: Could be any string, not necessarily a UUID
-      properties:
-        id:
-          type: string
-          description: User id.
-        name:
-          type: string
-          description: User name.
 
     TraceData:
       type: object
@@ -97,7 +76,7 @@ components:
           $ref: '#/components/schemas/MessageRole'
           description: Message role.
         timestamp:
-          $ref: '#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
           description: The timestamp message was sent or received.
         isError:
           type: boolean
@@ -135,7 +114,7 @@ components:
           type: string
           description: Summary text of the conversation over time.
         timestamp:
-          $ref: '#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
           description: The timestamp summary was updated.
         public:
           type: boolean
@@ -151,7 +130,7 @@ components:
       additionalProperties: false
       properties:
         id:
-          $ref: '#/components/schemas/UUID'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         error:
           type: object
           required:
@@ -175,9 +154,7 @@ components:
         - category
       properties:
         id:
-          oneOf:
-            - $ref: '#/components/schemas/UUID'
-            - $ref: '#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         title:
           type: string
           description: The conversation title.
@@ -187,7 +164,7 @@ components:
         summary:
           $ref: '#/components/schemas/ConversationSummary'
         'timestamp':
-          $ref: '#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         updatedAt:
           description: The last time conversation was updated.
           type: string
@@ -199,7 +176,7 @@ components:
         users:
           type: array
           items:
-            $ref: '#/components/schemas/User'
+            $ref: '../common_attributes.schema.yaml#/components/schemas/User'
         messages:
           type: array
           items:
@@ -224,9 +201,7 @@ components:
         - id
       properties:
         id:
-          oneOf:
-            - $ref: '#/components/schemas/UUID'
-            - $ref: '#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         title:
           type: string
           description: The conversation title.

x-pack/packages/kbn-elastic-assistant-common/impl/schemas/conversations/crud_conversation_route.gen.ts

@@ -19,10 +19,10 @@ import { z } from 'zod';
 import {
   ConversationCreateProps,
   ConversationResponse,
-  UUID,
   ConversationUpdateProps,
   ConversationMessageCreateProps,
 } from './common_attributes.gen';
+import { NonEmptyString } from '../common_attributes.gen';
 
 export type AppendConversationMessageRequestParams = z.infer<
   typeof AppendConversationMessageRequestParams
@@ -31,7 +31,7 @@ export const AppendConversationMessageRequestParams = z.object({
   /**
    * The conversation's `id` value.
    */
-  id: UUID,
+  id: NonEmptyString,
 });
 export type AppendConversationMessageRequestParamsInput = z.input<
   typeof AppendConversationMessageRequestParams
@@ -60,7 +60,7 @@ export const DeleteConversationRequestParams = z.object({
   /**
    * The conversation's `id` value.
    */
-  id: UUID,
+  id: NonEmptyString,
 });
 export type DeleteConversationRequestParamsInput = z.input<typeof DeleteConversationRequestParams>;
 
@@ -72,7 +72,7 @@ export const ReadConversationRequestParams = z.object({
   /**
    * The conversation's `id` value.
    */
-  id: UUID,
+  id: NonEmptyString,
 });
 export type ReadConversationRequestParamsInput = z.input<typeof ReadConversationRequestParams>;
 
@@ -84,7 +84,7 @@ export const UpdateConversationRequestParams = z.object({
   /**
    * The conversation's `id` value.
    */
-  id: UUID,
+  id: NonEmptyString,
 });
 export type UpdateConversationRequestParamsInput = z.input<typeof UpdateConversationRequestParams>;