Merge pull request #211 from openai/erinkav/temperature

Spec updates for temperature and message addition
openai · Mar 29, 2024 · 9d36a33 · 9d36a33
2 parents 399458c + 9fcd900
commit 9d36a33
Showing 1 changed file with 45 additions and 12 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -3766,7 +3766,8 @@ paths:
                 "tools": [],
                 "file_ids": [],
                 "metadata": {},
-                "usage": null
+                "usage": null,
+                "temperature": 1
               }
 
           - title: Streaming
@@ -4147,7 +4148,8 @@ paths:
                     "prompt_tokens": 123,
                     "completion_tokens": 456,
                     "total_tokens": 579
-                  }
+                  },
+                  "temperature": 1
                 },
                 {
                   "id": "run_abc456",
@@ -4178,7 +4180,8 @@ paths:
                     "prompt_tokens": 123,
                     "completion_tokens": 456,
                     "total_tokens": 579
-                  }
+                  },
+                  "temperature": 1
                 }
               ],
               "first_id": "run_abc123",
@@ -4277,7 +4280,8 @@ paths:
                   "file-abc456"
                 ],
                 "metadata": {},
-                "usage": null
+                "usage": null,
+                "temperature": 1
               }
           - title: Streaming
             request:
@@ -4612,7 +4616,8 @@ paths:
                 "prompt_tokens": 123,
                 "completion_tokens": 456,
                 "total_tokens": 579
-              }
+              },
+              "temperature": 1
             }
     post:
       operationId: modifyRun
@@ -4725,7 +4730,8 @@ paths:
                 "prompt_tokens": 123,
                 "completion_tokens": 456,
                 "total_tokens": 579
-              }
+              },
+              "temperature": 1
             }
 
   /threads/{thread_id}/runs/{run_id}/submit_tool_outputs:
@@ -4862,7 +4868,8 @@ paths:
                 ],
                 "file_ids": [],
                 "metadata": {},
-                "usage": null
+                "usage": null,
+                "temperature": 1
               }
 
           - title: Streaming
@@ -5061,7 +5068,8 @@ paths:
               ],
               "file_ids": [],
               "metadata": {},
-              "usage": null
+              "usage": null,
+              "temperature": 1
             }
 
   /threads/{thread_id}/runs/{run_id}/steps:
@@ -8522,6 +8530,10 @@ components:
           nullable: true
         usage:
           $ref: "#/components/schemas/RunCompletionUsage"
+        temperature:
+          description: The sampling temperature used for this run. If not set, defaults to 1.
+          type: number
+          nullable: true
       required:
         - id
         - object
@@ -8568,7 +8580,8 @@ components:
               "prompt_tokens": 123,
               "completion_tokens": 456,
               "total_tokens": 579
-            }
+            },
+            "temperature": 1
           }
     CreateRunRequest:
       type: object
@@ -8605,6 +8618,15 @@ components:
           type: object
           x-oaiTypeLabel: map
           nullable: true
+        temperature:
+          type: number
+          minimum: 0
+          maximum: 2
+          default: 1
+          example: 1
+          nullable: true
+          description: &run_temperature_description |
+            What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
         stream:
           type: boolean
           nullable: true
@@ -8733,6 +8755,14 @@ components:
           type: object
           x-oaiTypeLabel: map
           nullable: true
+        temperature:
+          type: number
+          minimum: 0
+          maximum: 2
+          default: 1
+          example: 1
+          nullable: true
+          description: *run_temperature_description
         stream:
           type: boolean
           nullable: true
@@ -8901,7 +8931,7 @@ components:
           type: string
           nullable: true
         run_id:
-          description: If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.
+          description: The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints.
           type: string
           nullable: true
         file_ids:
@@ -9024,8 +9054,11 @@ components:
       properties:
         role:
           type: string
-          enum: ["user"]
-          description: The role of the entity that is creating the message. Currently only `user` is supported.
+          enum: ["user", "assistant"]
+          description: |
+            The role of the entity that is creating the message. Allowed values include:
+            - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.
+            - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.
         content:
           type: string
           minLength: 1