Merge 931484e into b9cb5fd

Azure · Apr 26, 2024 · d1f66de · d1f66de
2 parents b9cb5fd + 931484e
commit d1f66de
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/specification/ai/OpenAI.Assistants/run_steps/models.tsp b/specification/ai/OpenAI.Assistants/run_steps/models.tsp
@@ -70,9 +70,31 @@ model RunStep {
   @doc("The Unix timestamp, in seconds, representing when this failed.")
   failedAt: utcDateTime | null;
 
+  #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality"
+  @doc("Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.")
+  @added(ServiceApiVersions.vFuturePlaceholder)
+  usage: RunStepCompletionUsage | null;
+
   ...RequiredNullableMetadata;
 }
 
+@doc("Usage statistics related to the run step.")
+@added(ServiceApiVersions.vFuturePlaceholder)
+model RunStepCompletionUsage {
+
+  @doc("Number of completion tokens used over the course of the run step.")
+  @encodedName("application/json", "completion_tokens")
+  completionTokens: int64;
+
+  @doc("Number of prompt tokens used over the course of the run step.")
+  @encodedName("application/json", "prompt_tokens")
+  promptTokens: int64;
+
+  @doc("Total number of tokens used (prompt + completion).")
+  @encodedName("application/json", "total_tokens")
+  totalTokens: int64;
+}
+
 @doc("The possible types of run steps.")
 @added(ServiceApiVersions.v2024_02_15_preview)
 union RunStepType {

diff --git a/specification/ai/OpenAI.Assistants/runs/models.tsp b/specification/ai/OpenAI.Assistants/runs/models.tsp
@@ -95,9 +95,31 @@ model ThreadRun {
   @doc("The Unix timestamp, in seconds, representing when this failed.")
   failedAt: utcDateTime | null;
 
+  #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality"
+  @doc("Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).")
+  @added(ServiceApiVersions.vFuturePlaceholder)
+  usage: RunCompletionUsage | null;
+
   ...RequiredNullableMetadata;
 }
 
+@doc("Usage statistics related to the run.")
+@added(ServiceApiVersions.vFuturePlaceholder)
+model RunCompletionUsage {
+
+  @doc("Number of completion tokens used over the course of the run.")
+  @encodedName("application/json", "completion_tokens")
+  completionTokens: int64;
+
+  @doc("Number of prompt tokens used over the course of the run.")
+  @encodedName("application/json", "prompt_tokens")
+  promptTokens: int64;
+
+  @doc("Total number of tokens used (prompt + completion).")
+  @encodedName("application/json", "total_tokens")
+  totalTokens: int64;
+}
+
 @doc("The details used when creating a new run of an assistant thread.")
 @added(ServiceApiVersions.v2024_02_15_preview)
 model CreateRunOptions {