feat(specs): add transformation copilot to ingestion

algolia · Aug 5, 2024 · 9b9b070 · 9b9b070
1 parent 84773e7
commit 9b9b070
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 0 deletions.
diff --git 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
@@ -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'