Inference results is a union of different fields

elastic · Nov 15, 2023 · 89bafd5 · 89bafd5
1 parent 8d8bf48
commit 89bafd5
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 63 deletions.
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/inference/_types/Results.ts b/specification/inference/_types/Results.ts
@@ -24,16 +24,26 @@ 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 doubles.
+ * of floats.
  */
 export type DenseVector = Array<float>
 
 /**
- * Inference result is the union of all the result types
+ * The text embedding result object
+ */
+export class TextEmbeddingResult {
+  embedding: DenseVector
+}
+
+/**
+ * InferenceResult is an aggregation of mutually exclusive variants
+ * @variants container
  */
-export type InferenceResult = SparseVector | DenseVector
+export class InferenceResult {
+  text_embedding?: Array<TextEmbeddingResult>
+  sparse_vector?: Array<SparseVector>
+}
diff --git a/specification/inference/_types/Services.ts b/specification/inference/_types/Services.ts
@@ -18,6 +18,7 @@
  */
 
 import { TaskType } from '../_types/TaskType'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
 /**
  * Configuration options when storing the model config
@@ -63,6 +64,6 @@ export class ModelConfigContainer {
   task_settings: TaskSettings
 }
 
-export class ServiceSettings {}
+export type ServiceSettings = UserDefinedValue
 
-export class TaskSettings {}
+export type TaskSettings = UserDefinedValue
diff --git a/specification/inference/inference/InferenceResponse.ts b/specification/inference/inference/InferenceResponse.ts
@@ -20,7 +20,5 @@
 import { InferenceResult } from '@inference/_types/Results'
 
 export class Response {
-  body: {
-    predicted_value: InferenceResult
-  }
+  body: InferenceResult
 }