Add _inference API (#2329)

specification/inference/_types/Results.ts

@@ -0,0 +1,53 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { float } from '@_types/Numeric'
+import { Dictionary } from '@spec_utils/Dictionary'
+
+/**
+ * Sparse Embedding tokens are represented as a dictionary
+ * of string to double.
+ */
+export type SparseVector = Dictionary<string, float>
+
+/**
+ * Text Embedding results are represented as Dense Vectors
+ * of floats.
+ */
+export type DenseVector = Array<float>
+
+export class SparseEmbeddingResult {
+  embedding: SparseVector
+}
+
+/**
+ * The text embedding result object
+ */
+export class TextEmbeddingResult {
+  embedding: DenseVector
+}
+
+/**
+ * InferenceResult is an aggregation of mutually exclusive variants
+ * @variants container
+ */
+export class InferenceResult {
+  text_embedding?: Array<TextEmbeddingResult>
+  sparse_embedding?: Array<SparseEmbeddingResult>
+}

specification/inference/_types/Services.ts

@@ -0,0 +1,57 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { TaskType } from '../_types/TaskType'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+
+/**
+ * Configuration options when storing the model config
+ */
+export class ModelConfig {
+  /**
+   * The service type
+   */
+  service: string
+  /**
+   * Settings specific to the service
+   */
+  service_settings: ServiceSettings
+  /**
+   * Task settings specific to the service and model
+   */
+  task_settings: TaskSettings
+}
+
+/**
+ * Represents a model as returned by the GET API
+ */
+export class ModelConfigContainer extends ModelConfig {
+  /**
+   * The model Id
+   */
+  model_id: string
+  /**
+   * The model's task type
+   */
+  task_type: TaskType
+}
+
+export type ServiceSettings = UserDefinedValue
+
+export type TaskSettings = UserDefinedValue

specification/inference/_types/TaskType.ts

@@ -0,0 +1,26 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Task types used in the API
+ */
+export enum TaskType {
+  sparse_embedding = 0,
+  text_embedding = 1
+}

specification/inference/delete_model/DeleteModelRequest.ts

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Id } from '@_types/common'
+import { TaskType } from '@inference/_types/TaskType'
+
+/**
+ * Delete an inference service model
+ * @rest_spec_name inference.delete_model
+ * @availability stack since=8.11.0 stability=experimental visibility=public
+ * @availability serverless stability=experimental visibility=private
+ */
+export interface Request extends RequestBase {
+  path_parts: {
+    /**
+     * The model task type
+     */
+    task_type: TaskType
+    /**
+     * The unique identifier of the inference model.
+     */
+    model_id: Id
+  }
+}

specification/inference/delete_model/DeleteModelResponse.ts

@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { AcknowledgedResponseBase } from '@_types/Base'
+
+export class Response {
+  body: AcknowledgedResponseBase
+}

specification/inference/get_model/GetModelRequest.ts

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Id } from '@_types/common'
+import { TaskType } from '@inference/_types/TaskType'
+
+/**
+ * Get an inference service model
+ * @rest_spec_name inference.get_model
+ * @availability stack since=8.11.0 stability=experimental visibility=public
+ * @availability serverless stability=experimental visibility=private
+ */
+export interface Request extends RequestBase {
+  path_parts: {
+    /**
+     * The model task type
+     */
+    task_type: TaskType
+    /**
+     * The unique identifier of the inference model.
+     */
+    model_id: Id
+  }
+}

specification/inference/get_model/GetModelResponse.ts

@@ -0,0 +1,26 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { ModelConfigContainer } from '@inference/_types/Services'
+
+export class Response {
+  body: {
+    models: Array<ModelConfigContainer>
+  }
+}