OPIK-546: Update create chat completions spec and SDKs (#892)

comet-ml · Dec 16, 2024 · 4e02d4e · 4e02d4e
1 parent ab6d79c
commit 4e02d4e
Show file tree

Hide file tree

Showing 76 changed files with 527 additions and 128 deletions.
diff --git a/apps/opik-documentation/documentation/rest_api/opik.yaml b/apps/opik-documentation/documentation/rest_api/opik.yaml
@@ -145,16 +145,16 @@ paths:
     post:
       tags:
       - Chat Completions
-      summary: Get chat completions
-      description: Get chat completions
-      operationId: getChatCompletions
+      summary: Create chat completions
+      description: Create chat completions
+      operationId: createChatCompletions
       requestBody:
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/ChatCompletionRequest'
       responses:
-        "501":
+        "200":
           description: Chat completions response
           content:
             text/event-stream:
@@ -3785,6 +3785,8 @@ components:
           items:
             type: string
     ProviderApiKey_Public:
+      required:
+      - provider
       type: object
       properties:
         id:
@@ -3812,6 +3814,7 @@ components:
     ProviderApiKey:
       required:
       - api_key
+      - provider
       type: object
       properties:
         id:
@@ -3841,6 +3844,7 @@ components:
     ProviderApiKey_Write:
       required:
       - api_key
+      - provider
       type: object
       properties:
         provider:
@@ -4291,6 +4295,18 @@ components:
         description:
           pattern: (?s)^\s*(\S.*\S|\S)\s*$
           type: string
+    ErrorInfo:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     Span:
       required:
       - name
@@ -4350,6 +4366,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
         created_at:
           type: string
           format: date-time
@@ -4372,6 +4390,18 @@ components:
         total_estimated_cost:
           type: number
           readOnly: true
+    ErrorInfo_Write:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     Span_Write:
       required:
       - name
@@ -4427,6 +4457,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Write'
     SpanBatch:
       required:
       - spans
@@ -4456,6 +4488,18 @@ components:
       properties:
         name:
           type: string
+    ErrorInfo_Public:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     FeedbackScore_Public:
       required:
       - name
@@ -4550,6 +4594,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Public'
         created_at:
           type: string
           format: date-time
@@ -4733,6 +4779,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
     Trace:
       required:
       - name
@@ -4769,6 +4817,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
         usage:
           type: object
           additionalProperties:
@@ -4830,6 +4880,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Write'
     TraceBatch:
       required:
       - traces
@@ -4884,6 +4936,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Public'
         usage:
           type: object
           additionalProperties:
@@ -4955,3 +5009,5 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
diff --git a/sdks/code_generation/fern/openapi/openapi.yaml b/sdks/code_generation/fern/openapi/openapi.yaml
@@ -145,16 +145,16 @@ paths:
     post:
       tags:
       - Chat Completions
-      summary: Get chat completions
-      description: Get chat completions
-      operationId: getChatCompletions
+      summary: Create chat completions
+      description: Create chat completions
+      operationId: createChatCompletions
       requestBody:
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/ChatCompletionRequest'
       responses:
-        "501":
+        "200":
           description: Chat completions response
           content:
             text/event-stream:
@@ -3785,6 +3785,8 @@ components:
           items:
             type: string
     ProviderApiKey_Public:
+      required:
+      - provider
       type: object
       properties:
         id:
@@ -3812,6 +3814,7 @@ components:
     ProviderApiKey:
       required:
       - api_key
+      - provider
       type: object
       properties:
         id:
@@ -3841,6 +3844,7 @@ components:
     ProviderApiKey_Write:
       required:
       - api_key
+      - provider
       type: object
       properties:
         provider:
@@ -4291,6 +4295,18 @@ components:
         description:
           pattern: (?s)^\s*(\S.*\S|\S)\s*$
           type: string
+    ErrorInfo:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     Span:
       required:
       - name
@@ -4350,6 +4366,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
         created_at:
           type: string
           format: date-time
@@ -4372,6 +4390,18 @@ components:
         total_estimated_cost:
           type: number
           readOnly: true
+    ErrorInfo_Write:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     Span_Write:
       required:
       - name
@@ -4427,6 +4457,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Write'
     SpanBatch:
       required:
       - spans
@@ -4456,6 +4488,18 @@ components:
       properties:
         name:
           type: string
+    ErrorInfo_Public:
+      required:
+      - exception_type
+      - traceback
+      type: object
+      properties:
+        exception_type:
+          type: string
+        message:
+          type: string
+        traceback:
+          type: string
     FeedbackScore_Public:
       required:
       - name
@@ -4550,6 +4594,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Public'
         created_at:
           type: string
           format: date-time
@@ -4733,6 +4779,8 @@ components:
           additionalProperties:
             type: integer
             format: int32
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
     Trace:
       required:
       - name
@@ -4769,6 +4817,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
         usage:
           type: object
           additionalProperties:
@@ -4830,6 +4880,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Write'
     TraceBatch:
       required:
       - traces
@@ -4884,6 +4936,8 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo_Public'
         usage:
           type: object
           additionalProperties:
@@ -4955,3 +5009,5 @@ components:
           type: array
           items:
             type: string
+        error_info:
+          $ref: '#/components/schemas/ErrorInfo'
diff --git a/sdks/python/src/opik/rest_api/__init__.py b/sdks/python/src/opik/rest_api/__init__.py
@@ -46,6 +46,9 @@
     DeleteFeedbackScore,
     Delta,
     DeltaRole,
+    ErrorInfo,
+    ErrorInfoPublic,
+    ErrorInfoWrite,
     ErrorMessage,
     ErrorMessageDetail,
     ErrorMessagePublic,
@@ -92,7 +95,6 @@
     JsonSchema,
     JsonSchemaElement,
     Message,
-    NotImplementedErrorBodyItem,
     NumericalFeedbackDefinition,
     NumericalFeedbackDefinitionCreate,
     NumericalFeedbackDefinitionPublic,
@@ -235,6 +237,9 @@
     "DeleteFeedbackScore",
     "Delta",
     "DeltaRole",
+    "ErrorInfo",
+    "ErrorInfoPublic",
+    "ErrorInfoWrite",
     "ErrorMessage",
     "ErrorMessageDetail",
     "ErrorMessagePublic",
@@ -288,7 +293,6 @@
     "Message",
     "NotFoundError",
     "NotImplementedError",
-    "NotImplementedErrorBodyItem",
     "NumericalFeedbackDefinition",
     "NumericalFeedbackDefinitionCreate",
     "NumericalFeedbackDefinitionPublic",