From 5478f603a45df98abb29bf79c317b81d96030f62 Mon Sep 17 00:00:00 2001
From: Pat Whelan <pat.whelan@elastic.co>
Date: Mon, 7 Oct 2024 15:10:36 -0400
Subject: [PATCH] [ML] Add Streaming Inference spec (#113812)

API for `/_inference/{task_type}/{inference_id}/_stream` and `/_inference/{inference_id}/_stream`

Request is `application/json`
Response is `text/event-stream`
---
 docs/changelog/113812.yaml                    |  5 ++
 .../api/inference.stream_inference.json       | 49 +++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 docs/changelog/113812.yaml
 create mode 100644 rest-api-spec/src/main/resources/rest-api-spec/api/inference.stream_inference.json

diff --git a/docs/changelog/113812.yaml b/docs/changelog/113812.yaml
new file mode 100644
index 0000000000000..04498b4ae5f7e
--- /dev/null
+++ b/docs/changelog/113812.yaml
@@ -0,0 +1,5 @@
+pr: 113812
+summary: Add Streaming Inference spec
+area: Machine Learning
+type: enhancement
+issues: []
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/inference.stream_inference.json b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.stream_inference.json
new file mode 100644
index 0000000000000..32b4b2f311837
--- /dev/null
+++ b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.stream_inference.json
@@ -0,0 +1,49 @@
+{
+  "inference.stream_inference":{
+    "documentation":{
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html",
+      "description":"Perform streaming inference"
+    },
+    "stability":"experimental",
+    "visibility":"public",
+    "headers":{
+      "accept": [ "text/event-stream"],
+      "content_type": ["application/json"]
+    },
+    "url":{
+      "paths":[
+        {
+          "path":"/_inference/{inference_id}/_stream",
+          "methods":[
+            "POST"
+          ],
+          "parts":{
+            "inference_id":{
+              "type":"string",
+              "description":"The inference Id"
+            }
+          }
+        },
+        {
+          "path":"/_inference/{task_type}/{inference_id}/_stream",
+          "methods":[
+            "POST"
+          ],
+          "parts":{
+            "task_type":{
+              "type":"string",
+              "description":"The task type"
+            },
+            "inference_id":{
+              "type":"string",
+              "description":"The inference Id"
+            }
+          }
+        }
+      ]
+    },
+    "body":{
+      "description":"The inference payload"
+    }
+  }
+}