Add inference endpoints management page (#184614)

## Description In this PR, we implemented a view for managing inference endpoints. The changes include the following items for both **Serverless** and **Stack**. - A blank page will be displayed if no inference endpoints are available. - A page displaying a list of inference endpoints. The user can view various details about each endpoint, such as the endpoint itself, the provider, and the type. The table supports pagination and sorting. - Users can add a new inference endpoint using Elasticsearch models and third-party APIs, including Hugging Face, Cohere, and OpenAI. To keep the changes in this PR manageable, the following items are **out of scope** but will be added in subsequent PRs - Option to delete an inference endpoint - Filtering and Search bar - Information about allocations, thread. - Icons for **Provider** - Deployment status of underlying trained models ## Empty page in Stack Management https://github.com/elastic/kibana/assets/132922331/e2064ee8-3623-457f-8a04-19603e97e815 ## Page with all inference endpoints in Stack Management https://github.com/elastic/kibana/assets/132922331/89bec450-1569-4425-b013-5058b577b95a ## Inference Endpoints Management in Serverless https://github.com/elastic/kibana/assets/132922331/bd8b6b71-0e09-49f4-aa9a-19338a1da225 --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: kibanamachine <[email protected]>
elastic · Jun 13, 2024 · db425e3 · db425e3
1 parent 0486de7
commit db425e3
Show file tree

Hide file tree

Showing 92 changed files with 6,825 additions and 3 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -717,6 +717,7 @@ x-pack/plugins/search_connectors @elastic/search-kibana
 packages/kbn-search-errors @elastic/kibana-data-discovery
 examples/search_examples @elastic/kibana-data-discovery
 packages/kbn-search-index-documents @elastic/search-kibana
+x-pack/plugins/search_inference_endpoints @elastic/search-kibana
 x-pack/plugins/search_notebooks @elastic/search-kibana
 x-pack/plugins/search_playground @elastic/search-kibana
 packages/kbn-search-response-warnings @elastic/kibana-data-discovery

diff --git a/config/serverless.es.yml b/config/serverless.es.yml
@@ -64,5 +64,8 @@ data_visualizer.resultLinks.fileBeat.enabled: false
 # Search Playground
 xpack.searchPlayground.ui.enabled: true
 
+# Search InferenceEndpoints
+xpack.searchInferenceEndpoints.ui.enabled: false
+
 # Search Notebooks
 xpack.search.notebooks.catalog.url: https://elastic-enterprise-search.s3.us-east-2.amazonaws.com/serverless/catalog.json
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -785,6 +785,10 @@ It uses Chromium and Puppeteer underneath to run the browser in headless mode.
 |This plugin contains common assets and endpoints for the use of connectors in Kibana. Primarily used by the enterprise_search and serverless_search plugins.
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/search_inference_endpoints/README.md[searchInferenceEndpoints]
+|The Inference Endpoints is a tool used to manage inference endpoints
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/search_notebooks/README.mdx[searchNotebooks]
 |This plugin contains endpoints and components for rendering search python notebooks in the persistent dev console.
 

diff --git a/package.json b/package.json
@@ -728,6 +728,7 @@
     "@kbn/search-errors": "link:packages/kbn-search-errors",
     "@kbn/search-examples-plugin": "link:examples/search_examples",
     "@kbn/search-index-documents": "link:packages/kbn-search-index-documents",
+    "@kbn/search-inference-endpoints": "link:x-pack/plugins/search_inference_endpoints",
     "@kbn/search-notebooks": "link:x-pack/plugins/search_notebooks",
     "@kbn/search-playground": "link:x-pack/plugins/search_playground",
     "@kbn/search-response-warnings": "link:packages/kbn-search-response-warnings",

diff --git a/packages/deeplinks/search/constants.ts b/packages/deeplinks/search/constants.ts
@@ -8,10 +8,12 @@
 
 export const ENTERPRISE_SEARCH_APP_ID = 'enterpriseSearch';
 export const ENTERPRISE_SEARCH_CONTENT_APP_ID = 'enterpriseSearchContent';
+export const ENTERPRISE_SEARCH_INFERENCE_ENDPOINTS_APP_ID = 'enterpriseSearchInferenceEndpoints';
 export const ENTERPRISE_SEARCH_APPLICATIONS_APP_ID = 'enterpriseSearchApplications';
 export const ENTERPRISE_SEARCH_ANALYTICS_APP_ID = 'enterpriseSearchAnalytics';
 export const ENTERPRISE_SEARCH_APPSEARCH_APP_ID = 'appSearch';
 export const ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID = 'workplaceSearch';
 export const SERVERLESS_ES_APP_ID = 'serverlessElasticsearch';
 export const SERVERLESS_ES_CONNECTORS_ID = 'serverlessConnectors';
 export const SERVERLESS_ES_SEARCH_PLAYGROUND_ID = 'searchPlayground';
+export const SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID = 'searchInferenceEndpoints';
diff --git a/packages/deeplinks/search/deep_links.ts b/packages/deeplinks/search/deep_links.ts
@@ -16,6 +16,7 @@ import {
   ENTERPRISE_SEARCH_APPSEARCH_APP_ID,
   ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID,
   SERVERLESS_ES_SEARCH_PLAYGROUND_ID,
+  SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID,
 } from './constants';
 
 export type EnterpriseSearchApp = typeof ENTERPRISE_SEARCH_APP_ID;
@@ -27,6 +28,7 @@ export type EnterpriseSearchWorkplaceSearchApp = typeof ENTERPRISE_SEARCH_WORKPL
 export type ServerlessSearchApp = typeof SERVERLESS_ES_APP_ID;
 export type ConnectorsId = typeof SERVERLESS_ES_CONNECTORS_ID;
 export type SearchPlaygroundId = typeof SERVERLESS_ES_SEARCH_PLAYGROUND_ID;
+export type SearchInferenceEndpointsId = typeof SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID;
 
 export type ContentLinkId = 'searchIndices' | 'connectors' | 'webCrawlers';
 
@@ -44,6 +46,7 @@ export type DeepLinkId =
   | ServerlessSearchApp
   | ConnectorsId
   | SearchPlaygroundId
+  | SearchInferenceEndpointsId
   | `${EnterpriseSearchContentApp}:${ContentLinkId}`
   | `${EnterpriseSearchApplicationsApp}:${ApplicationsLinkId}`
   | `${EnterpriseSearchAppsearchApp}:${AppsearchLinkId}`;
diff --git a/packages/deeplinks/search/index.ts b/packages/deeplinks/search/index.ts
@@ -9,6 +9,7 @@
 export {
   ENTERPRISE_SEARCH_APP_ID,
   ENTERPRISE_SEARCH_CONTENT_APP_ID,
+  ENTERPRISE_SEARCH_INFERENCE_ENDPOINTS_APP_ID,
   ENTERPRISE_SEARCH_APPLICATIONS_APP_ID,
   ENTERPRISE_SEARCH_ANALYTICS_APP_ID,
   ENTERPRISE_SEARCH_APPSEARCH_APP_ID,

diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml
@@ -31,7 +31,7 @@ pageLoadAssetSize:
   dataQuality: 19384
   datasetQuality: 50624
   dataViewEditor: 28082
-  dataViewFieldEditor: 27000
+  dataViewFieldEditor: 42021
   dataViewManagement: 5300
   dataViews: 65000
   dataVisualizer: 27530
@@ -41,8 +41,8 @@ pageLoadAssetSize:
   discoverShared: 17111
   embeddable: 87309
   embeddableEnhanced: 22107
-  enterpriseSearch: 50858
-  esqlDataGrid: 24598
+  enterpriseSearch: 66810
+  esqlDataGrid: 24582
   esUiShared: 326654
   eventAnnotation: 30000
   eventAnnotationListing: 25841
@@ -132,6 +132,7 @@ pageLoadAssetSize:
   screenshotMode: 17856
   screenshotting: 22870
   searchConnectors: 30000
+  searchInferenceEndpoints: 20470
   searchNotebooks: 18942
   searchPlayground: 19325
   searchprofiler: 67080

diff --git a/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts
@@ -135,6 +135,7 @@ export const applicationUsageSchema = {
   canvas: commonSchema,
   enterpriseSearch: commonSchema,
   enterpriseSearchContent: commonSchema,
+  enterpriseSearchInferenceEndpoints: commonSchema,
   enterpriseSearchAnalytics: commonSchema,
   enterpriseSearchApplications: commonSchema,
   enterpriseSearchAISearch: commonSchema,

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -2098,6 +2098,137 @@
             }
           }
         },
+        "enterpriseSearchInferenceEndpoints": {
+          "properties": {
+            "appId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "The application being tracked"
+              }
+            },
+            "viewId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "Always `main`"
+              }
+            },
+            "clicks_total": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application since we started counting them"
+              }
+            },
+            "clicks_7_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 7 days"
+              }
+            },
+            "clicks_30_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 30 days"
+              }
+            },
+            "clicks_90_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 90 days"
+              }
+            },
+            "minutes_on_screen_total": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen since we started counting them."
+              }
+            },
+            "minutes_on_screen_7_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 7 days"
+              }
+            },
+            "minutes_on_screen_30_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 30 days"
+              }
+            },
+            "minutes_on_screen_90_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 90 days"
+              }
+            },
+            "views": {
+              "type": "array",
+              "items": {
+                "properties": {
+                  "appId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application being tracked"
+                    }
+                  },
+                  "viewId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application view being tracked"
+                    }
+                  },
+                  "clicks_total": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the application sub view since we started counting them"
+                    }
+                  },
+                  "clicks_7_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 7 days"
+                    }
+                  },
+                  "clicks_30_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 30 days"
+                    }
+                  },
+                  "clicks_90_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 90 days"
+                    }
+                  },
+                  "minutes_on_screen_total": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application sub view is active and on-screen since we started counting them."
+                    }
+                  },
+                  "minutes_on_screen_7_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 7 days"
+                    }
+                  },
+                  "minutes_on_screen_30_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 30 days"
+                    }
+                  },
+                  "minutes_on_screen_90_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 90 days"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
         "enterpriseSearchAnalytics": {
           "properties": {
             "appId": {

diff --git a/test/plugin_functional/test_suites/core_plugins/rendering.ts b/test/plugin_functional/test_suites/core_plugins/rendering.ts
@@ -314,6 +314,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) {
         'xpack.rollup.ui.enabled (boolean)',
         'xpack.saved_object_tagging.cache_refresh_interval (duration)',
         'xpack.searchPlayground.ui.enabled (boolean)',
+        'xpack.searchInferenceEndpoints.ui.enabled (boolean)',
         'xpack.security.loginAssistanceMessage (string)',
         'xpack.security.sameSiteCookies (alternatives)',
         'xpack.security.showInsecureClusterWarning (boolean)',

diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1428,6 +1428,8 @@
       "@kbn/search-examples-plugin/*": ["examples/search_examples/*"],
       "@kbn/search-index-documents": ["packages/kbn-search-index-documents"],
       "@kbn/search-index-documents/*": ["packages/kbn-search-index-documents/*"],
+      "@kbn/search-inference-endpoints": ["x-pack/plugins/search_inference_endpoints"],
+      "@kbn/search-inference-endpoints/*": ["x-pack/plugins/search_inference_endpoints/*"],
       "@kbn/search-notebooks": ["x-pack/plugins/search_notebooks"],
       "@kbn/search-notebooks/*": ["x-pack/plugins/search_notebooks/*"],
       "@kbn/search-playground": ["x-pack/plugins/search_playground"],

diff --git a/x-pack/.i18nrc.json b/x-pack/.i18nrc.json
@@ -94,6 +94,7 @@
     "xpack.screenshotting": "plugins/screenshotting",
     "xpack.searchNotebooks": "plugins/search_notebooks",
     "xpack.searchPlayground": "plugins/search_playground",
+    "xpack.searchInferenceEndpoints": "plugins/search_inference_endpoints",
     "xpack.searchProfiler": "plugins/searchprofiler",
     "xpack.security": "plugins/security",
     "xpack.server": "legacy/server",

diff --git a/x-pack/plugins/enterprise_search/common/constants.ts b/x-pack/plugins/enterprise_search/common/constants.ts
@@ -8,6 +8,7 @@
 import {
   ENTERPRISE_SEARCH_APP_ID,
   ENTERPRISE_SEARCH_CONTENT_APP_ID,
+  ENTERPRISE_SEARCH_INFERENCE_ENDPOINTS_APP_ID,
   ENTERPRISE_SEARCH_APPLICATIONS_APP_ID,
   ENTERPRISE_SEARCH_ANALYTICS_APP_ID,
   ENTERPRISE_SEARCH_APPSEARCH_APP_ID,
@@ -176,6 +177,22 @@ export const VECTOR_SEARCH_PLUGIN = {
   URL: '/app/enterprise_search/vector_search',
 };
 
+export const INFERENCE_ENDPOINTS_PLUGIN = {
+  ID: ENTERPRISE_SEARCH_INFERENCE_ENDPOINTS_APP_ID,
+  NAME: i18n.translate('xpack.enterpriseSearch.inferenceEndpoints.productName', {
+    defaultMessage: 'Inference Endpoints',
+  }),
+  NAV_TITLE: i18n.translate('xpack.enterpriseSearch.inferenceEndpoints.navTitle', {
+    defaultMessage: 'Relevance',
+  }),
+  DESCRIPTION: i18n.translate('xpack.enterpriseSearch.inferenceEndpoints.description', {
+    defaultMessage: 'View for managing inference endpoints.',
+  }),
+  URL: '/app/enterprise_search/relevance',
+  LOGO: 'logoEnterpriseSearch',
+  SUPPORT_URL: 'https://discuss.elastic.co/c/enterprise-search/',
+};
+
 export const LICENSED_SUPPORT_URL = 'https://support.elastic.co';
 
 export const JSON_HEADER = {

diff --git a/x-pack/plugins/enterprise_search/kibana.jsonc b/x-pack/plugins/enterprise_search/kibana.jsonc
@@ -31,6 +31,7 @@
       "console",
       "searchConnectors",
       "searchPlayground",
+      "searchInferenceEndpoints",
       "embeddable",
       "discover",
       "charts",

diff --git a/...ck/plugins/enterprise_search/public/applications/__mocks__/kea_logic/kibana_logic.mock.ts b/...ck/plugins/enterprise_search/public/applications/__mocks__/kea_logic/kibana_logic.mock.ts
@@ -64,6 +64,7 @@ export const mockKibanaValues = {
     hasWebCrawler: true,
   },
   renderHeaderActions: jest.fn(),
+  searchInferenceEndpoints: null,
   searchPlayground: searchPlaygroundMock.createStart(),
   security: securityMock.createStart(),
   setBreadcrumbs: jest.fn(),

diff --git a/...search/public/applications/enterprise_search_relevance/components/inference_endpoints.tsx b/...search/public/applications/enterprise_search_relevance/components/inference_endpoints.tsx
@@ -0,0 +1,42 @@
+/*
+ * 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 React from 'react';
+
+import { useValues } from 'kea';
+
+import { i18n } from '@kbn/i18n';
+
+import { KibanaLogic } from '../../shared/kibana';
+
+import { EnterpriseSearchRelevancePageTemplate } from './layout/page_template';
+
+export const InferenceEndpoints: React.FC = () => {
+  const { searchInferenceEndpoints } = useValues(KibanaLogic);
+
+  if (!searchInferenceEndpoints) {
+    return null;
+  }
+  return (
+    <searchInferenceEndpoints.InferenceEdnpointsProvider>
+      <EnterpriseSearchRelevancePageTemplate
+        pageChrome={[
+          i18n.translate('xpack.enterpriseSearch.relevance.inferenceEndpoints.breadcrumb', {
+            defaultMessage: 'Inference Endpoints',
+          }),
+        ]}
+        pageViewTelemetry="InferenceEndpoints"
+        restrictWidth={false}
+        customPageSections
+        bottomBorder="extended"
+        docLink="inference_endpoints"
+      >
+        <searchInferenceEndpoints.InferenceEndpoints />
+      </EnterpriseSearchRelevancePageTemplate>
+    </searchInferenceEndpoints.InferenceEdnpointsProvider>
+  );
+};
diff --git a/...erprise_search/public/applications/enterprise_search_relevance/components/layout/index.ts b/...erprise_search/public/applications/enterprise_search_relevance/components/layout/index.ts
@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export { EnterpriseSearchRelevancePageTemplate } from './page_template';