update

Author: mrbullwinkle

articles/ai-services/openai/assistants-reference-messages.md

@@ -1,7 +1,7 @@
 ---
 title: Azure OpenAI Service Assistants Python & REST API messages reference 
 titleSuffix: Azure OpenAI
-description: Learn how to use Azure OpenAI's Python & REST API messages with Assistants
+description: Learn how to use Azure OpenAI's Python & REST API messages with Assistants.
 manager: nitinme
 ms.service: azure-ai-openai
 ms.topic: conceptual
@@ -37,11 +37,11 @@ Create a message.
 | `role` | string | Required | The role of the entity that is creating the message. Currently only user is supported.|
 | `content` | string | Required | The content of the message. |
 | `file_ids` | array | Optional | A list of File IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like retrieval and code_interpreter that can access and use files. |
-| `metadata` | map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. |
+| `metadata` | map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. |
 
 ### Returns
 
-A message object.
+A [message](#message-object) object.
 
 ### Example create message request
 
@@ -80,7 +80,6 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/mess
 
 ## List messages
 
-
 ```http
 GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-02-15-preview
 ```
@@ -105,7 +104,7 @@ Returns a list of messages for a given thread.
 
 ### Returns
 
-A list of message objects.
+A list of [message](#message-object) objects.
 
 ### Example list messages request
 
@@ -159,7 +158,7 @@ Returns a list of message files.
 
 ### Returns
 
-A list of message file objects
+A list of [message file](#message-file-object) objects
 
 ### Example list message files request
 
@@ -210,7 +209,7 @@ Retrieves a message file.
 
 ### Returns
 
-The message file object.
+The [message file](#message-file-object) object.
 
 ### Example retrieve message request
 
@@ -255,13 +254,13 @@ Retrieves a message file.
 
 |Parameter| Type | Required | Description |
 |---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread which the message and file belongs to. |
+|`thread_id` | string | Required | The ID of the thread, which the message and file belongs to. |
 |`message_id`| string | Required | The ID of the message that the file belongs to. |
 |`file_id` | string | Required | The ID of the file being retrieved. |
 
 **Returns**
 
-The message file object.
+The [message file](#message-file-object) object.
 
 ### Example retrieve message file request
 
@@ -314,7 +313,7 @@ Modifies a message.
 
 |Parameter| Type | Required | Description |
 |---|---|---|---|
-| metadata | map| Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.|
+| metadata | map| Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
 
 ### Returns
 
@@ -375,16 +374,15 @@ Represents a message within a thread.
 | `assistant_id` | string or null  |If applicable, the ID of the assistant that authored this message.|
 | `run_id` | string or null  |If applicable, the ID of the run associated with the authoring of this message.|
 | `file_ids` | array  |A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.|
-| `metadata` | map  |Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.|
+| `metadata` | map  |Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
 
 ## Message file object
 
-A list of files attached to a `message`
+A list of files attached to a message.
 
 |Name | Type | Description |
 |---  |---   |---         |
 | `id`| string | The identifier, which can be referenced in API endpoints.|
 |`object`|string| The object type, which is always `thread.message.file`.|
 |`created_at`|integer | The Unix timestamp (in seconds) for when the message file was created.|
-|`message_id`| string | The ID of the message that the File is attached to.|
-
+|`message_id`| string | The ID of the message that the File is attached to.|

articles/ai-services/openai/assistants-reference-runs.md

@@ -1,7 +1,7 @@
 ---
 title: Azure OpenAI Service Assistants Python & REST API runs reference 
 titleSuffix: Azure OpenAI
-description: Learn how to use Azure OpenAI's Python & REST API runs with Assistants
+description: Learn how to use Azure OpenAI's Python & REST API runs with Assistants.
 manager: nitinme
 ms.service: azure-ai-openai
 ms.topic: conceptual
@@ -35,11 +35,11 @@ Create a run.
 |Name | Type | Required | Description |
 |---  |---   |---       |--- |
 | `assistant_id` | string | Required | The ID of the assistant to use to execute this run. |
-| `model` | string or null | Optional | The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. |
+| `model` | string or null | Optional | The model deployment name to be used to execute this run. If a value is provided here, it will override the model deployment name associated with the assistant. If not, the model deployment name associated with the assistant will be used. |
 | `instructions` | string or null | Optional | Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis. |
 | `additional_instructions` | string or null | Optional | Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. |
 | `tools` | array or null | Optional | Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. |
-| `metadata` | map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. |
+| `metadata` | map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. |
 
 ### Returns
 
@@ -92,7 +92,7 @@ Create a thread and run it in a single request.
 |---  |---   |---       |--- |
 | `assistant_id` | string  | Required | The ID of the assistant to use to execute this run.|
 | `thread` | object  | Optional | |
-| `model` | string or null  | Optional | The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.|
+| `model` | string or null  | Optional | The ID of the Model deployment name to be used to execute this run. If a value is provided here, it will override the model deployment name associated with the assistant. If not, the model deployment name associated with the assistant will be used.|
 | `instructions` | string or null  | Optional | Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.|
 | `tools` | array or null  | Optional | Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.|
 | `metadata` | map  | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
@@ -167,7 +167,7 @@ Returns a list of runs belonging to a thread.
 
 ### Returns
 
-A list of run objects.
+A list of [run](#run-object) objects.
 
 ### Example list runs request
 
@@ -224,7 +224,7 @@ Returns a list of steps belonging to a run.
 
 ### Returns
 
-A list of run step objects.
+A list of [run step](#run-step-object) objects.
 
 ### Example list run steps request
 
@@ -273,7 +273,7 @@ Retrieves a run.
 
 ### Returns
 
-The run object matching the specified run ID.
+The [run](#run-object) object matching the specified run ID.
 
 ### Example list run steps request
 
@@ -323,7 +323,7 @@ Retrieves a run step.
 
 ### Returns
 
-The run step object matching the specified ID.
+The [run step](#run-step-object) object matching the specified ID.
 
 ### Example retrieve run steps request
 
@@ -377,6 +377,10 @@ Modifies a run.
 |---  |---   |---       |--- |
 | `metadata` | map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
 
+### Returns
+
+The modified [run](#run-object) object matching the specified ID.
+
 ### Example modify run request
 
 # [Python 1.x](#tab/python)
@@ -432,11 +436,11 @@ When a run has the status: "requires_action" and required_action.type is submit_
 
 |Name | Type | Required | Description |
 |---  |---   |---       |--- |
-| `tool_outputs | array | Required | |
+| `tool_outputs | array | Required | A list of tools for which the outputs are being submitted. |
 
 ### Returns
 
-The modified run object matching the specified ID.
+The modified [run](#run-object) object matching the specified ID.
 
 ### Example submit tool outputs to run request
 
@@ -500,7 +504,7 @@ Cancels a run that is in_progress.
 
 ### Returns
 
-The modified run object matching the specified ID.
+The modified [run](#run-object) object matching the specified ID.
 
 ### Example submit tool outputs to run request
 
@@ -544,20 +548,20 @@ Represents an execution run on a thread.
 | `created_at` | integer | The Unix timestamp (in seconds) for when the run was created.|
 | `thread_id` | string | The ID of the thread that was executed on as a part of this run.|
 | `assistant_id` | string | The ID of the assistant used for execution of this run.|
-| `status` | string | The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.|
+| `status` | string | The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.|
 | `required_action` | object or null | Details on the action required to continue the run. Will be null if no action is required.|
 | `last_error` | object or null | The last error associated with this run. Will be null if there are no errors.|
 | `expires_at` | integer | The Unix timestamp (in seconds) for when the run will expire.|
 | `started_at` | integer or null | The Unix timestamp (in seconds) for when the run was started.|
-| `cancelled_at` | integer or null | The Unix timestamp (in seconds) for when the run was cancelled.|
+| `cancelled_at` | integer or null | The Unix timestamp (in seconds) for when the run was canceled.|
 | `failed_at` | integer or null | The Unix timestamp (in seconds) for when the run failed.|
 | `completed_at` | integer or null | The Unix timestamp (in seconds) for when the run was completed.|
-| `model` | string | The model that the assistant used for this run.|
+| `model` | string | The model deployment name that the assistant used for this run.|
 | `instructions` | string | The instructions that the assistant used for this run.|
 | `tools` | array | The list of tools that the assistant used for this run.|
 | `file_ids` | array | The list of File IDs the assistant used for this run.|
 | `metadata` | map | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
-| `usage` | object or null | 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.).|
+
 
 ## Run step object
 
@@ -572,12 +576,12 @@ Represent a step in execution of a run.
 | `thread_id`| string | The ID of the thread that was run.|
 | `run_id`| string | The ID of the run that this run step is a part of.|
 | `type`| string | The type of run step, which can be either message_creation or tool_calls.|
-| `status`| string | The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.|
+| `status`| string | The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.|
 | `step_details`| object | The details of the run step.|
 | `last_error`| object or null | The last error associated with this run step. Will be null if there are no errors.|
 | `expired_at`| integer or null | The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.|
 | `cancelled_at`| integer or null | The Unix timestamp (in seconds) for when the run step was cancelled.|
 | `failed_at`| integer or null | The Unix timestamp (in seconds) for when the run step failed.|
 | `completed_at`| integer or null | The Unix timestamp (in seconds) for when the run step completed.|
 | `metadata`| map | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.|
-| `usage`| object or null | Usage statistics related to the run step. This value will be null while the run step's status is in_progress.|
+

articles/ai-services/openai/assistants-reference-threads.md

@@ -29,11 +29,11 @@ Create a thread.
 |Name | Type | Required | Description |
 |---  |---   |---       |--- |
 |`messages`|array| Optional | A list of messages to start the thread with. |
-|`metadata`| map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. |
+|`metadata`| map | Optional | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. |
 
 ### Returns
 
-A thread object.
+A [thread object](#thread-object).
 
 ### Example create thread request
 
@@ -131,7 +131,7 @@ Modifies a thread.
 
 ### Returns
 
-The modified thread object matching the specified ID.
+The modified [thread object](#thread-object) matching the specified ID.
 
 ### Example modify thread request
 
@@ -169,6 +169,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-
       }
     }' 
 ```
+
 ---
 
 ## Delete thread
@@ -214,6 +215,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-
   -H 'Content-Type: application/json' \
   -X DELETE
 ```
+
 ---
 ## Thread object