From 9b9b070e98ffb0fe78493a177df54f9cab4d9f99 Mon Sep 17 00:00:00 2001
From: Thomas Raffray <Fluf22@users.noreply.github.com>
Date: Mon, 5 Aug 2024 16:49:08 +0200
Subject: [PATCH] feat(specs): add transformation copilot to ingestion

---
 .../common/schemas/transformation.yml         | 21 ++++++++++++++
 .../transformationsCopilot.yml                | 29 +++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 specs/ingestion/paths/transformations/transformationsCopilot.yml

diff --git a/specs/ingestion/common/schemas/transformation.yml b/specs/ingestion/common/schemas/transformation.yml
index e037871a6b..65718b954a 100644
--- a/specs/ingestion/common/schemas/transformation.yml
+++ b/specs/ingestion/common/schemas/transformation.yml
@@ -119,3 +119,24 @@ TransformationTryResponse:
           type: string
   required:
     - payloads
+
+Model:
+  type: object
+  additionalProperties: false
+  properties:
+    fullname:
+      type: string
+    modelName:
+      type: string
+    systemPrompt:
+      type: string
+    id:
+      type: string
+    provider:
+      type: string
+  required:
+    - fullname
+    - modelName
+    - systemPrompt
+    - id
+    - provider
diff --git a/specs/ingestion/paths/transformations/transformationsCopilot.yml b/specs/ingestion/paths/transformations/transformationsCopilot.yml
new file mode 100644
index 0000000000..986b9a1855
--- /dev/null
+++ b/specs/ingestion/paths/transformations/transformationsCopilot.yml
@@ -0,0 +1,29 @@
+get:
+  tags:
+    - transformations
+  summary: Retrieve existing LLM transformation helpers
+  description: Retrieves a list of existing LLM transformation helpers.
+  operationId: listCopilots
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: listTransformationModels
+            type: object
+            description: List of available copilot LLM for transformation purposes.
+            additionalProperties: false
+            properties:
+              llms:
+                type: array
+                items:
+                  $ref: '../../common/schemas/transformation.yml#/Model'
+            required:
+              - llms
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'