# ハイライト
このコードの変更では、Azure OpenAIサービスに関連する一連のAPIリファレンスドキュメントが削除され、バッチ処理関連のドキュメントが最新のAPIバージョンにアップデートされました。また、モデルマトリックスとTOC（目次）ファイルにもいくつかの更新が行われています。

新しい機能

モデルマトリックスに新しいリージョンとモデルが追加され、最新のモデルのサポート状況が把握できるように。

破壊的変更

Assistants APIリファレンスに関連する複数のドキュメントが削除され、ユーザーは代替ドキュメントを探す必要がある。
ドキュメント構成の見直しにより、リンクや内容が大幅に変更。

その他の更新

バッチ処理用のPythonコードとREST APIが最新のプレビュー版APIに対応。
TOCファイルのリンクが更新され、APIリファレンスへのアクセスが改善。

インサイト

この変更では、APIリファレンスの大幅な見直しが行われており、特にAssistants APIに関する複数の主要なドキュメントが削除されています。この削除は、APIのバージョン移行やドキュメントポリシーの更新に伴うものと推測されます。この結果として、開発者やユーザーは新しい情報源やリファレンスを見つける必要があり、これまでの開発フローに大きな影響が予想されます。

一方で、バッチ処理やモデルマトリックスに関する情報がアップデートされ、最新の機能やモデルの利用が可能となります。特に、新しいリージョンやモデルの追加は、ユーザーにとって選択肢の幅を広げる重要な情報です。また、TOCファイルの更新によってリファレンスへのアクセスが改善され、ユーザーエクスペリエンスの向上が期待されます。

全体的に、この変更は既存のドキュメント体系を大幅に改変し、最新のAPIバージョンに適合した形での情報提供を目指していることが伺えます。しかし、旧来の情報を利用していたユーザーには一時的な混乱が生じる可能性もあるため、新しいドキュメントや情報への迅速な移行が求められます。

Summary Table

Filename	Type	Title	Status	A	D	M
assistants-reference-messages.md	breaking change	Assistants APIメッセージリファレンスの削除	removed	0	316	316
assistants-reference-runs.md	breaking change	Assistants APIランリファレンスの削除	removed	0	751	751
assistants-reference-threads.md	breaking change	Assistants APIスレッドリファレンスの削除	removed	0	244	244
assistants-reference.md	breaking change	Assistants APIリファレンスの削除	removed	0	370	370
batch.md	minor update	バッチ処理ドキュメントの更新	modified	5	4	9
batch-python.md	minor update	バッチ処理用PythonコードのAPIバージョン更新	modified	4	4	8
batch-rest.md	minor update	バッチ処理APIのバージョン更新	modified	8	8	16
datazone-standard.md	minor update	データゾーンの標準モデルマトリックスの更新	modified	2	1	3
standard-global.md	minor update	グローバルモデルマトリックスの更新	modified	27	26	53
toc.yml	minor update	TOCファイルの更新	modified	7	5	12

Modified Contents

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

Diff

@@ -1,316 +0,0 @@
----
-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.
-manager: nitinme
-ms.service: azure-ai-openai
-ms.topic: reference
-ms.date: 03/31/2025
-author: aahill
-ms.author: aahi
-recommendations: false
-ms.custom: devx-track-python
----
-
-# Assistants API (Preview) messages reference
-
-This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
-
-## Create message
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview
-```
-
-Create a message.
-
-**Path parameter**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to create a message for. |
-
-**Request body**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |---          |
-| `role` | string | Required | The role of the entity that is creating the message. Can be `user` or `assistant`. `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` | string | Required | The content of the message. |
-| `attachments` | array | Optional | A list of files attached to the message, and the tools they should be added to. |
-| `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](#message-object) object.
-
-### Example create message request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-thread_message = client.beta.threads.messages.create(
-  "thread_abc123",
-  role="user",
-  content="How does AI work? Explain it in simple terms.",
-)
-print(thread_message)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-      "role": "user",
-      "content": "How does AI work? Explain it in simple terms."
-    }' 
-```
-
----
-
-## List messages
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview
-```
-
-Returns a list of messages for a given thread.
-
-**Path Parameters**
-
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that messages belong to. |
-
-**Query Parameters**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| `limit` | integer | Optional - Defaults to 20 |A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.|
-| `order` | string | Optional - Defaults to desc |Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.|
-| `after` | string | Optional | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.|
-| `run_id` | string | Optionanl | Filter messages by the run ID that generated them. |
-| `before` | string | Optional | A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.|
-
-### Returns
-
-A list of [message](#message-object) objects.
-
-### Example list messages request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-thread_messages = client.beta.threads.messages.list("thread_abc123")
-print(thread_messages.data)
-
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Retrieve message
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview
-```
-
-Retrieves a message file.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that the message belongs to. |
-|`message_id`| string | Required | The ID of the message to retrieve. |
-
-
-### Returns
-
-The [message](#message-object) object matching the specified ID.
-
-### Example retrieve message request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-05-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-message = client.beta.threads.messages.retrieve(
-  message_id="msg_abc123",
-  thread_id="thread_abc123",
-)
-print(message)
-
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Modify message
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview
-```
-
-Modifies a message.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to which the message belongs. |
-|`message_id`| string | Required | The ID of the message to modify. |
-
-**Request body**
-
-|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 maximum of 512 characters long.|
-
-### Returns
-
-The modified [message](#message-object) object.
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-message = client.beta.threads.messages.update(
-  message_id="msg_abc12",
-  thread_id="thread_abc123",
-  metadata={
-    "modified": "true",
-    "user": "abc123",
-  },
-)
-print(message)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview
-``` \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-      "metadata": {
-        "modified": "true",
-        "user": "abc123"
-      }
-    }'  
-   
-```
-
----
-
-## Delete message
-
-
-```http
-DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview
-```
-
-Deletes a message.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to which the message belongs. |
-|`message_id`| string | Required | The ID of the message to modify. |
-
-### Returns
-
-The deletion status of the [message](#message-object) object.
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-deleted_message = client.beta.threads.messages.delete(
-  message_id="msg_abc12",
-  thread_id="thread_abc123",
-)
-print(deleted_message)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl -x DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json'
-```
-
----
-
-## Message object
-
-Represents a message within a thread.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `id` | string  |The identifier, which can be referenced in API endpoints.|
-| `object` | string  |The object type, which is always thread.message.|
-| `created_at` | integer  |The Unix timestamp (in seconds) for when the message was created.|
-| `thread_id` | string  |The thread ID that this message belongs to.|
-| `role` | string  |The entity that produced the message. One of `user` or `assistant`.|
-| `content` | array  |The content of the message in array of text and/or images.|
-| `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 maximum of 512 characters long.|

Summary

{
    "modification_type": "breaking change",
    "modification_title": "Assistants APIメッセージリファレンスの削除"
}

Explanation

この変更は、「assistants-reference-messages.md」というファイルの完全な削除を示しています。このファイルは、Azure OpenAIサービス用のAssistants APIに関連するPythonおよびREST APIメッセージのリファレンスとして機能していました。削除されたことにより、ユーザーはこれまで使用していたメッセージ作成、リスト、取得、修正、削除操作に関する全てのドキュメントにアクセスできなくなりました。この変更は、APIのバージョン変更、またはドキュメンテーション戦略の見直しに伴うものである可能性があります。具体的には、ファイル内で提供されていた情報や例は削除され、合わせて316行のコンテンツが削られています。これにより、開発者やユーザーは新たなリファレンスや代替のドキュメントを探さなければならなくなります。

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

Diff

@@ -1,751 +0,0 @@
----
-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.
-manager: nitinme
-ms.service: azure-ai-openai
-ms.topic: reference
-ms.date: 03/31/2025
-author: aahill
-ms.author: aahi
-recommendations: false
-ms.custom: devx-track-python
----
-
-# Assistants API (Preview) runs reference
-
-This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
-
-## Create run
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-08-01-preview
-```
-
-Create a run.
-
-**Path parameter**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to create a message for. |
-
-**Request body**
-
-|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 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 | 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. |
-| `additional_messages` | array | Optional | Adds additional messages to the thread before creating the run. |
-| `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. |
-| `temperature` | number | Optional | 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. Default is 1. |
-| `top_p` | number | Optional | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. Default is 1. |
-| `stream` | boolean | optional | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. |
-| `max_prompt_tokens` | integer | optional | The maximum number of completion tokens that might be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. |
-| `max_completion_tokens` | integer | optional | The maximum number of completion tokens that might be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. |
-| `truncation_strategy` | [truncationObject](#truncation-object) | optional | Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. |
-| `tool_choice` | string or object | optional | Controls which (if any) tool is called by the model. A `none` value means the model won't call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling a tool. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. |
-| `response_format` | string or object | optional | Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. <br> Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. <br> **Important**: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model might generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content might be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. |
-
-
-### Returns
-
-A run object.
-
-### Example create run request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.runs.create(
-  thread_id="thread_abc123",
-  assistant_id="asst_abc123"
-)
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-    "assistant_id": "asst_abc123"
-  }'
-```
-
----
-
-## Create thread and run
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/runs?api-version=2024-08-01-preview
-```
-
-Create a thread and run it in a single request.
-
-**Request Body**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| `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 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.|
-| `temperature` | number | Optional | 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. Default is 1. |
-| `top_p` | number | Optional | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. Default is 1. |
-| `stream` | boolean | optional | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. |
-| `max_prompt_tokens` | integer | optional | The maximum number of completion tokens that might be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. |
-| `max_completion_tokens` | integer | optional | The maximum number of completion tokens that might be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. |
-| `truncation_strategy` | [truncationObject](#truncation-object) | optional | Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. |
-| `tool_choice` | string or object | optional | Controls which (if any) tool is called by the model. A `none` value means the model won't call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling a tool. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. |
-| `response_format` | string or object | optional | Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. <br> Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. <br> **Important**: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model might generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content might be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. |
-
-### Returns
-
-A run object.
-
-### Example create thread and run request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.create_and_run(
-  assistant_id="asst_abc123",
-  thread={
-    "messages": [
-      {"role": "user", "content": "Explain deep learning to a 5 year old."}
-    ]
-  }
-)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/runs?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-      "assistant_id": "asst_abc123",
-      "thread": {
-        "messages": [
-          {"role": "user", "content": "Explain deep learning to a 5 year old."}
-        ]
-      }
-    }'
-```
-
----
-
-## List runs
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-08-01-preview
-```
-
-Returns a list of runs belonging to a thread.
-
-**Path parameter**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that the run belongs to. |
-
-**Query Parameters**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| `limit` | integer | Optional - Defaults to 20 |A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.|
-| `order` | string | Optional - Defaults to desc |Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.|
-| `after` | string | Optional | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.|
-| `before` | string | Optional | A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.|
-
-### Returns
-
-A list of [run](#run-object) objects.
-
-### Example list runs request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-runs = client.beta.threads.runs.list(
-  "thread_abc123"
-)
-print(runs)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-05-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## List run steps
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-08-01-preview
-```
-
-Returns a list of steps belonging to a run.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that the run belongs to. |
-|`run_id` | string | Required | The ID of the run associated with the run steps to be queried. |
-
-**Query parameters**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| `limit` | integer | Optional - Defaults to 20 |A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.|
-| `order` | string | Optional - Defaults to desc |Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.|
-| `after` | string | Optional | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.|
-| `before` | string | Optional | A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.|
-
-### Returns
-
-A list of [run step](#run-step-object) objects.
-
-### Example list run steps request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run_steps = client.beta.threads.runs.steps.list(
-    thread_id="thread_abc123",
-    run_id="run_abc123"
-)
-print(run_steps)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Retrieve run
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import OpenAI
-client = OpenAI()
-
-run = client.beta.threads.runs.retrieve(
-  thread_id="thread_abc123",
-  run_id="run_abc123"
-)
-
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```http
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-08-01-preview
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-Retrieves a run.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that was run. |
-|`run_id` | string | Required | The ID of the run to retrieve. |
-
-### Returns
-
-The [run](#run-object) object matching the specified run ID.
-
-### Example list run steps request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.runs.retrieve(
-  thread_id="thread_abc123",
-  run_id="run_abc123"
-)
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Retrieve run step
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-08-01-preview
-```
-
-Retrieves a run step.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to which the run and run step belongs. |
-|`run_id` | string | Required | The ID of the run to which the run step belongs. |
-|`step_id`| string | Required | The ID of the run step to retrieve.|
-
-### Returns
-
-The [run step](#run-step-object) object matching the specified ID.
-
-### Example retrieve run steps request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run_step = client.beta.threads.runs.steps.retrieve(
-    thread_id="thread_abc123",
-    run_id="run_abc123",
-    step_id="step_abc123"
-)
-print(run_step)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Modify run
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-08-01-preview
-```
-
-Modifies a run.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread that was run. |
-|`run_id` | string | Required | The ID of the run to modify. |
-
-**Request body**
-
-|Name | 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 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)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.runs.update(
-  thread_id="thread_abc123",
-  run_id="run_abc123",
-  metadata={"user_id": "user_abc123"},
-)
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-  -d '{
-    "metadata": {
-      "user_id": "user_abc123"
-    }
-  }'
-```
-
----
-
-## Submit tool outputs to run
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-08-01-preview
-```
-
-When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to which this run belongs.|
-|`run_id` | string | Required | The ID of the run that requires the tool output submission. |
-
-**Request body**
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| `tool_outputs` | array | Required | A list of tools for which the outputs are being submitted. |
-| `stream` | boolean | Optional | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. |
-
-### Returns
-
-The modified [run](#run-object) object matching the specified ID.
-
-### Example submit tool outputs to run request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.runs.submit_tool_outputs(
-  thread_id="thread_abc123",
-  run_id="run_abc123",
-  tool_outputs=[
-    {
-      "tool_call_id": "call_abc123",
-      "output": "28C"
-    }
-  ]
-)
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-    "tool_outputs": [
-      {
-        "tool_call_id": "call_abc123",
-        "output": "28C"
-      }
-    ]
-  }'
-
-```
-
----
-
-## Cancel a run
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-08-01-preview
-```
-
-Cancels a run that is in_progress.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to which this run belongs.|
-|`run_id` | string | Required | The ID of the run to cancel. |
-
-### Returns
-
-The modified [run](#run-object) object matching the specified ID.
-
-### Example submit tool outputs to run request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-run = client.beta.threads.runs.cancel(
-  thread_id="thread_abc123",
-  run_id="run_abc123"
-)
-print(run)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -X POST
-```
-
----
-
-## Run object
-
-Represents an execution run on a thread.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `id`| string | The identifier, which can be referenced in API endpoints.|
-| `object` | string | The object type, which is always thread.run.|
-| `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`.|
-| `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 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 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.|
-| `tool_choice` | string or object | Controls which (if any) tool is called by the model. `none` means the model won't call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling a tool. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. |
-| `max_prompt_tokens` | integer or null | The maximum number of prompt tokens specified to have been used over the course of the run. |
-| `max_completion_tokens` | integer or null | The maximum number of completion tokens specified to have been used over the course of the run. |
-| `usage` | object or null | Usage statistics related to the run. This value will be null if the run is not in a terminal state (for example `in_progress`, `queued`). |
-| `truncation_strategy` | object | Controls for how a thread will be truncated prior to the run. | 
-| `response_format` | string | The format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. |
-| `tool_choice` | string | Controls which (if any) tool is called by the model. `none` means the model won't call any tools and instead generates a message. `auto` is the default value and means the model can pick between generating a message or calling a tool. |
-
-## Run step object
-
-Represent a step in execution of a run.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `id`| string | The identifier of the run step, which can be referenced in API endpoints.|
-| `object`| string | The object type, which is always thread.run.step.|
-| `created_at`| integer | The Unix timestamp (in seconds) for when the run step was created.|
-| `assistant_id`| string | The ID of the assistant associated with the run step.|
-| `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`.|
-| `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 canceled.|
-| `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.|
-
-## Stream a run result (preview)
-
-Stream the result of executing a Run or resuming a Run after submitting tool outputs. You can stream events after:
-* [Create Thread and Run](#create-thread-and-run) 
-* [Create Run](#create-run)
-* [Submit Tool Outputs](#submit-tool-outputs-to-run) 
-
-To stream a result, pass `"stream": true` while creating a run. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream.
-
-### Streaming example
-
-```python
-from typing_extensions import override
-from openai import AssistantEventHandler
- 
-# First, we create a EventHandler class to define
-# how we want to handle the events in the response stream.
- 
-class EventHandler(AssistantEventHandler):    
-  @override
-  def on_text_created(self, text) -> None:
-    print(f"\nassistant > ", end="", flush=True)
-      
-  @override
-  def on_text_delta(self, delta, snapshot):
-    print(delta.value, end="", flush=True)
-      
-  def on_tool_call_created(self, tool_call):
-    print(f"\nassistant > {tool_call.type}\n", flush=True)
-  
-  def on_tool_call_delta(self, delta, snapshot):
-    if delta.type == 'code_interpreter':
-      if delta.code_interpreter.input:
-        print(delta.code_interpreter.input, end="", flush=True)
-      if delta.code_interpreter.outputs:
-        print(f"\n\noutput >", flush=True)
-        for output in delta.code_interpreter.outputs:
-          if output.type == "logs":
-            print(f"\n{output.logs}", flush=True)
- 
-# Then, we use the `create_and_stream` SDK helper 
-# with the `EventHandler` class to create the Run 
-# and stream the response.
- 
-with client.beta.threads.runs.stream(
-  thread_id=thread.id,
-  assistant_id=assistant.id,
-  instructions="Please address the user as Jane Doe. The user has a premium account.",
-  event_handler=EventHandler(),
-) as stream:
-  stream.until_done()
-```
-
-## Truncation object
-
-Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.
-
-| Name | Type | Description | Required |
-|---  |---   |---         |
-| `type` | string | The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. | Yes |	
-| `last_messages`	| integer | The number of most recent messages from the thread when constructing the context for the run. | No | 
-
-## Message delta object
-
-Represents a message delta. For example any changed fields on a message during streaming.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `id` | string | The identifier of the message, which can be referenced in API endpoints. |
-| `object` | string | The object type, which is always `thread.message.delta`. |
-| `delta` | object | The delta containing the fields that have changed on the Message. |
-
-## Run step delta object
-
-Represents a run step delta. For example any changed fields on a run step during streaming.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `id` | string | The identifier of the run step, which can be referenced in API endpoints. |
-| `object` | string | The object type, which is always `thread.run.step.delta`. |
-| `delta` | object | The delta containing the fields that have changed on the run step.
-
-## Assistant stream events
-
-Represents an event emitted when streaming a Run. Each event in a server-sent events stream has an event and data property:
-
-```json
-event: thread.created
-data: {"id": "thread_123", "object": "thread", ...}
-```
-
-Events are emitted whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas). For example, `thread.run.created` is emitted when a new run is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses to create a message during a run, we emit a `thread.message.created` event, a `thread.message.in_progress` event, many thread.`message.delta` events, and finally a `thread.message.completed` event.
-
-|Name | Type | Description |
-|---  |---   |---         |
-| `thread.created` | `data` is a thread. | Occurs when a new thread is created. |
-| `thread.run.created` | `data` is a run. | Occurs when a new run is created. |
-| `thread.run.queued` | `data` is a run. | Occurs when a run moves to a queued status. |
-| `thread.run.in_progress` | `data` is a run. | Occurs when a run moves to an in_progress status. |
-| `thread.run.requires_action` | `data` is a run. | Occurs when a run moves to a `requires_action` status. |
-| `thread.run.completed` | `data` is a run. | Occurs when a run is completed. |
-| `thread.run.failed` | `data` is a run. | Occurs when a run fails. |
-| `thread.run.cancelling` | `data` is a run. | Occurs when a run moves to a `cancelling` status. |
-| `thread.run.cancelled` | `data` is a run. | Occurs when a run is canceled. |
-| `thread.run.expired` | `data` is a run. | Occurs when a run expires. |
-| `thread.run.step.created` | `data` is a run step. | Occurs when a run step is created. |
-| `thread.run.step.in_progress` | `data` is a run step. | Occurs when a run step moves to an `in_progress` state. | 
-| `thread.run.step.delta` | `data` is a run step delta. | Occurs when parts of a run step are being streamed. |
-| `thread.run.step.completed` | `data` is a run step. | Occurs when a run step is completed. |
-| `thread.run.step.failed` | `data` is a run step. | Occurs when a run step fails. |
-| `thread.run.step.cancelled` | `data` is a run step. | Occurs when a run step is canceled. |
-| `thread.run.step.expired` | `data` is a run step. | Occurs when a run step expires. |
-| `thread.message.created` | `data` is a message. | Occurs when a message is created. |
-| `thread.message.in_progress` | `data` is a message. | Occurs when a message moves to an in_progress state. | 
-| `thread.message.delta` | `data` is a message delta. | Occurs when parts of a Message are being streamed. |
-| `thread.message.completed` | `data` is a message. | Occurs when a message is completed. |
-| `thread.message.incomplete` | `data` is a message. | Occurs when a message ends before it is completed. |
-| `error` | `data` is an error. | Occurs when an error occurs. This can happen due to an internal server error or a timeout. |
-| `done` | `data` is `[DONE]` | Occurs when a stream ends. |

Summary

{
    "modification_type": "breaking change",
    "modification_title": "Assistants APIランリファレンスの削除"
}

Explanation

この変更は、「assistants-reference-runs.md」というファイルの削除を示しています。このファイルは、Azure OpenAIサービスにおけるAssistants APIのPythonおよびREST APIランに関するリファレンスドキュメントを提供していました。削除されたコンテンツは751行であり、ユーザーはランの作成、スレッドおよびランのリスト、特定のランの取得や修正等に関する情報にアクセスできなくなります。この変更は、APIのバージョン更新または文書構成の見直しの一環であると考えられます。このことにより、開発者は新しいリファレンスまたは代替文書を求める必要が生じます。また、提供されていたサンプルコードや使用例は消失したため、これに依存していたユーザーには影響が大きいと言えます。

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

Diff

@@ -1,244 +0,0 @@
----
-title: Azure OpenAI Service Assistants Python & REST API threads reference 
-titleSuffix: Azure OpenAI
-description: Learn how to use Azure OpenAI's Python & REST API threads with Assistants.
-manager: nitinme
-ms.service: azure-ai-openai
-ms.topic: reference
-ms.date: 03/31/2025
-author: aahill
-ms.author: aahi
-recommendations: false
-ms.custom: devx-track-python
----
-
-# Assistants API (Preview) threads reference
-
-This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
-
-## Create a thread
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-08-01-preview
-```
-
-Create a thread.
-
-**Request body**
-
-|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 maximum of 512 characters long. |
-| `tool_resources` | [object](#tool_resources-properties) | Optional | A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. |
-
-### tool_resources properties
-
-**code_interpreter**
-
-| Name | Type | Description | Default |
-|---  |---   |---       |--- |
-| `file_ids` | array | A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool. | `[]` |
-
-**file_search** 
-
-| Name | Type | Description | Default |
-|---  |---   |---       |--- |
-| `vector_store_ids` | array | The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. | `[]` | 
-| `vector_stores` | array | A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. | `[]` |
-
-### Returns
-
-A [thread object](#thread-object).
-
-### Example: create thread request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-empty_thread = client.beta.threads.create()
-print(empty_thread)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d ''
-```
-
----
-
-## Retrieve thread
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview
-```
-
-Retrieves a thread.
-
-**Path parameters**
-
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to retrieve |
-
-### Returns
-
-The thread object matching the specified ID.
-
-### Example: retrieve thread request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-my_thread = client.beta.threads.retrieve("thread_abc123")
-print(my_thread)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Modify thread
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview
-```
-
-Modifies a thread.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to modify. |
-
-**Request body**
-
-|Name | 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 maximum of 512 characters long.|
-| `tool_resources` | [object](#tool_resources-properties) | Optional | A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. |
-
-### Returns
-
-The modified [thread object](#thread-object) matching the specified ID.
-
-### Example: modify thread request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-my_updated_thread = client.beta.threads.update(
-  "thread_abc123",
-  metadata={
-    "modified": "true",
-    "user": "abc123"
-  }
-)
-print(my_updated_thread)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-      "metadata": {
-        "modified": "true",
-        "user": "abc123"
-      }
-    }' 
-```
-
----
-
-## Delete thread
-
-```http
-DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview
-```
-
-Delete a thread.
-
-**Path Parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-|`thread_id` | string | Required | The ID of the thread to delete. |
-
-### Returns
-
-Deletion status.
-
-### Example: delete thread request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-05-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-response = client.beta.threads.delete("thread_abc123")
-print(response)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -X DELETE
-```
-
----
-## Thread object
-
-| Field  | Type  | Description   |
-|---|---|---|
-| `id` | string | The identifier, which can be referenced in API endpoints.|
-| `object` | string | The object type, which is always thread. |
-| `created_at` | integer | The Unix timestamp (in seconds) for when the thread was created. |
-| `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. |

Summary

{
    "modification_type": "breaking change",
    "modification_title": "Assistants APIスレッドリファレンスの削除"
}

Explanation

この変更は、「assistants-reference-threads.md」というファイルの削除を示しています。このファイルは、Azure OpenAIサービス用のAssistants APIのスレッドに関するPythonおよびREST APIのリファレンスドキュメントを提供していました。削除されたコンテンツは244行であり、ユーザーはスレッドの作成、取得、修正、削除に関する具体的な操作方法や例にアクセスできなくなります。この変更は、新しいAPIバージョンへの移行またはドキュメンテーション戦略の見直しによるものである可能性があります。これにより、開発者やユーザーは新たなリファレンスを探す必要が生じ、機能の理解や実装において障害が発生する可能性があります。これまでの例や情報が消失することで、ユーザーは新しい文書を参照することなく、同様の機能を効果的に活用することが難しくなります。

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

Diff

@@ -1,370 +0,0 @@
----
-title: Azure OpenAI Service Assistants Python & REST API reference
-titleSuffix: Azure OpenAI
-description: Learn how to use Azure OpenAI's Python & REST API with Assistants.
-manager: nitinme
-ms.service: azure-ai-openai
-ms.topic: reference
-ms.date: 02/27/2025
-author: aahill
-ms.author: aahi
-recommendations: false
-ms.custom: devx-track-python
----
-
-# Assistants API (Preview) reference
-
-This article provides reference documentation for Python and REST for the new Assistants API (Preview). More in-depth step-by-step guidance is provided in the [getting started guide](./how-to/assistant.md).
-
-## Create an assistant
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
-```
-
-Create an assistant with a model and instructions.
-
-### Request body
-
-|Name | Type | Required | Description |
-|---  |---   |---       |--- |
-| model| string | Required | Model deployment name of the model to use.|
-| name | string or null | Optional | The name of the assistant. The maximum length is 256 characters.|
-| description| string or null | Optional | The description of the assistant. The maximum length is 512 characters.|
-| instructions | string or null | Optional | The system instructions that the assistant uses. The maximum length is 256,000 characters.|
-| tools | array | Optional | Defaults to []. A list of tools enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can currently be of types `code_interpreter`, or `function`. A `function` description can be a maximum of 1,024 characters. |
-| 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.|
-| temperature | number or null | Optional | Defaults to 1. Determines 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. |
-| top_p | number or null | Optional | Defaults to 1. An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
-| response_format | string or object | Optional | Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106. Setting this parameter to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. Importantly, when using JSON mode, you must also instruct the model to produce JSON yourself using a system or user message. Without this instruction, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Additionally, the message content may be partially cut off if you use `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. |
-| tool_resources | object | Optional | A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. |
-
-### response_format types
-
-**string**
-
-`auto` is the default value.
-
-**object**
-
-Possible `type` values: `text`, `json_object`, `json_schema`.
-
-***json_schema***
-
-| Name | Type | Description | Default | Required/Optional |
-|---  |---   |---       |--- |--- |
-| `description` | string | A description of what the response format is for, used by the model to determine how to respond in the format. |  | Optional |
-| `name` | string | The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |  | Required |
-| `schema` | object | The schema for the response format, described as a JSON Schema object. |  | Optional |
-| `strict` | boolean or null | Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. | false | Optional |
-
-### tool_resources properties
-
-**code_interpreter**
-
-| Name | Type | Description | Default |
-|---  |---   |---       |--- |
-| `file_ids` | array | A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool. | `[]` |
-
-**file_search**
-
-| Name | Type | Description | Required/Optional |
-|---  |---   |---       |--- |
-| `vector_store_ids` | array | The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. | Optional | 
-| `vector_stores` | array | A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. | Optional |
-
-***vector_stores***
-
-| Name | Type | Description | Required/Optional |
-|---  |---   |---       |--- |
-| `file_ids` | array | A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. | Optional | 
-| `chunking_strategy` | object | The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. | Optional |
-| `metadata` | map | Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. | Optional |
-
-***chunking_strategy***
-
-| Name | Type | Description | Required/optional | 
-|---  |---   |---       |---|
-| `Auto Chunking Strategy` | object | The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. `type` is always `auto` | Required |
-| `Static Chunking Strategy` | object | `type` Always `static`  | Required |
-
-***Static Chunking Strategy***
-
-| Name | Type | Description | Required/Optional |
-|---  |---   |---       |--- |
-| `max_chunk_size_tokens` | integer | The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. | Required |
-| `chunk_overlap_tokens` | integer | The number of tokens that overlap between chunks. The default value is `400`. Note that the overlap must not exceed half of `max_chunk_size_tokens`. | Required |
-
-### Returns
-
-An [assistant](#assistant-object) object.
-
-### Example create assistant request
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-assistant = client.beta.assistants.create(
-  instructions="You are an AI assistant that can write code to help answer math questions",
-  model="<REPLACE WITH MODEL DEPLOYMENT NAME>", # replace with model deployment name. 
-  tools=[{"type": "code_interpreter"}]
-)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-08-01-preview \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-    "instructions": "You are an AI assistant that can write code to help answer math questions.",
-    "tools": [
-      { "type": "code_interpreter" }
-    ],
-    "model": "gpt-4-1106-preview"
-  }'
-```
-
----
-
-## List assistants
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
-```
-
-Returns a list of all assistants.
-
-**Query parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-| `limit` | integer | Optional | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.|
-| `order` | string | Optional - Defaults to desc | Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.|
-| `after` | string | Optional | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. |
-|`before`| string | Optional | A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. |
-
-### Returns
-
-A list of [assistant](#assistant-object) objects
-
-### Example list assistants
-
-# [Python 1.x](#tab/python)
-
-```python
-from openai import AzureOpenAI
-    
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-my_assistants = client.beta.assistants.list(
-    order="desc",
-    limit="20",
-)
-print(my_assistants.data)
-
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-08-01-preview  \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-
-## Retrieve assistant
-
-```http
-GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-08-01-preview
-```
-
-Retrieves an assistant.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|--|
-| `assistant_id` | string | Required | The ID of the assistant to retrieve. |
-
-**Returns**
-
-The [assistant](#assistant-object) object matching the specified ID.
-
-### Example retrieve assistant
-
-# [Python 1.x](#tab/python)
-
-```python
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-my_assistant = client.beta.assistants.retrieve("asst_abc123")
-print(my_assistant)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant-id}?api-version=2024-08-01-preview  \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' 
-```
-
----
-
-## Modify assistant
-
-```http
-POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-08-01-preview
-```
-
-Modifies an assistant.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-| assistant_id | string | Required | The ID of the assistant the file belongs to. |
-
-**Request Body**
-
-| Parameter | Type | Required | Description |
-| --- | --- | --- | --- |
-| `model` | | Optional | The model deployment name of the model to use. |
-| `name` | string or null | Optional | The name of the assistant. The maximum length is 256 characters. |
-| `description` | string or null | Optional | The description of the assistant. The maximum length is 512 characters. |
-| `instructions` | string or null | Optional | The system instructions that the assistant uses. The maximum length is 32768 characters. |
-| `tools` | array | Optional | Defaults to []. A list of tools enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, or function. A `function` description can be a maximum of 1,024 characters. |
-| `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. |
-| `temperature` | number or null | Optional | Defaults to 1. Determines 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. |
-| `top_p` | number or null | Optional | Defaults to 1. An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
-| `response_format` | string or object | Optional | Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106. Setting this parameter to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. Importantly, when using JSON mode, you must also instruct the model to produce JSON yourself using a system or user message. Without this instruction, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Additionally, the message content may be partially cut off if you use `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. |
-| `tool_resources` | object | Optional | A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. |
-
-**Returns**
-
-The modified [assistant object](#assistant-object).
-
-### Example modify assistant
-
-# [Python 1.x](#tab/python)
-
-```python
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-my_updated_assistant = client.beta.assistants.update(
-  "asst_abc123",
-  instructions="You are an HR bot, and you have access to files to answer employee questions about company policies. Always respond with info from either of the files.",
-  name="HR Helper",
-  tools=[{"type": "code-interpreter"}],
-  model="gpt-4", #model = model deployment name
-)
-
-print(my_updated_assistant)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant-id}?api-version=2024-08-01-preview  \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -d '{
-      "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
-      "tools": [{"type": "code-interpreter"}],
-      "model": "gpt-4"
-    }'
-```
-
----
-
-## Delete assistant
-
-```http
-DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-08-01-preview
-```
-
-Delete an assistant.
-
-**Path parameters**
-
-|Parameter| Type | Required | Description |
-|---|---|---|---|
-| `assistant_id` | string | Required | The ID of the assistant the file belongs to. |
-
-**Returns**
-
-Deletion status.
-
-### Example delete assistant
-
-# [Python 1.x](#tab/python)
-
-```python
-client = AzureOpenAI(
-    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-08-01-preview",
-    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-    )
-
-response = client.beta.assistants.delete("asst_abc123")
-print(response)
-```
-
-# [REST](#tab/rest)
-
-```console
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant-id}?api-version=2024-08-01-preview  \
-  -H "api-key: $AZURE_OPENAI_API_KEY" \
-  -H 'Content-Type: application/json' \
-  -X DELETE
-```
-
----
-
-## File upload API reference
-
-Assistants use the [same API for file upload as fine-tuning](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP&preserve-view=true). When uploading a file you have to specify an appropriate value for the [purpose parameter](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP#purpose&preserve-view=true).
-
-
-## Assistant object
-
-| Field  | Type  | Description   |
-|---|---|---|
-| `id` | string | The identifier, which can be referenced in API endpoints.|
-| `object` | string | The object type, which is always assistant.|
-| `created_at` | integer | The Unix timestamp (in seconds) for when the assistant was created.|
-| `name` | string or null | The name of the assistant. The maximum length is 256 characters.|
-| `description` | string or null | The description of the assistant. The maximum length is 512 characters.|
-| `model` | string | Name of the model deployment name to use.|
-| `instructions` | string or null | The system instructions that the assistant uses. The maximum length is 32768 characters.|
-| `tools` | array | A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, or function. A `function` description can be a maximum of 1,024 characters.|
-| `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.|
-| `temperature` | number or null | Defaults to 1. Determines 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. |
-| `top_p` | number or null | Defaults to 1. An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
-| `response_format` | string or object | Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106. Setting this parameter to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. Importantly, when using JSON mode, you must also instruct the model to produce JSON yourself using a system or user message. Without this instruction, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Additionally, the message content may be partially cut off if you use `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. |
-| `tool_resources` | object | A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. |

Summary

{
    "modification_type": "breaking change",
    "modification_title": "Assistants APIリファレンスの削除"
}

Explanation

この変更は、「assistants-reference.md」というファイルの削除を示しています。このファイルは、Azure OpenAIサービス用のAssistants APIに関するPythonおよびREST APIの包括的なリファレンスドキュメントを提供していました。削除内容は370行に及び、ユーザーはAssistantの作成、修正、取得、削除に関する詳細な情報や例にアクセスできなくなります。この変更は、APIの更新やドキュメンテーションへのアプローチの見直しが意図されている可能性があります。削除によって、開発者は自身のプロジェクトでこれらの機能を使用する際に新たなリファレンスや代替手段を見つける必要が生じ、作業において混乱や障害が発生する可能性があります。特にこれまでの使用者にとって、ドキュメントの消失は情報を失うことを意味し、実装や効果的な利用に困難さを引き起こすことが考えられます。

articles/ai-services/openai/how-to/batch.md

Diff

@@ -34,7 +34,7 @@ Key use cases include:
 * **Marketing and Personalization:** Generate personalized content and recommendations at scale.
 
 > [!IMPORTANT]
-> We aim to process batch requests within 24 hours; we do not expire the jobs that take longer. You can [cancel](#cancel-batch) the job anytime. When you cancel the job, any remaining work is cancelled and any already completed work is returned. You will be charged for any completed work.
+> We aim to process batch requests within 24 hours; we don't expire the jobs that take longer. You can [cancel](#cancel-batch) the job anytime. When you cancel the job, any remaining work is cancelled and any already completed work is returned. You'll be charged for any completed work.
 >
 > Data stored at rest remains in the designated Azure geography, while data may be processed for inferencing in any Azure OpenAI location. [Learn more about data residency](https://azure.microsoft.com/explore/global-infrastructure/data-residency/).  
 
@@ -77,9 +77,10 @@ Refer to the [models page](../concepts/models.md) for the most up-to-date inform
 |   | API Version   |
 |---|---|
 |**Latest GA API release:**| `2024-10-21`|
-|**Latest Preview API release:**| `2025-01-01-preview`|
+|**Latest Preview API release:**| `2025-03-01-preview`|
 
-Support first added in: `2024-07-01-preview`
+> [!NOTE]
+> While Global Batch supports older API versions, some models require newer preview API versions. For example, `o3-mini` isn't supported with `2024-10-21` since it was released after this date. To access the newer models with global batch use the latest preview API version.
 
 ### Feature support
 
@@ -240,7 +241,7 @@ When a job failure occurs, you'll find details about the failure in the `errors`
 
 - Resources deployed with Azure CLI won't work out-of-box with Azure OpenAI global batch. This is due to an issue where resources deployed using this method have endpoint subdomains that don't follow the `https://your-resource-name.openai.azure.com` pattern. A workaround for this issue is to deploy a new Azure OpenAI resource using one of the other common deployment methods which will properly handle the subdomain setup as part of the deployment process.
 
-- UTF-8-BOM encoded `jsonl` files are not supported. JSON lines files should be encoded using UTF-8. Use of Byte-Order-Mark (BOM) encoded files is not officially supported by the JSON RFC spec, and Azure OpenAI will currently treat BOM encoded files as invalid. A UTF-8-BOM encoded file will currently return the generic error message: "Validation failed: A valid model deployment name could not be extracted from the input file. Please ensure that each row in the input file has a valid deployment name specified in the 'model' field, and that the deployment name is consistent across all rows."
+- UTF-8-BOM encoded `jsonl` files aren't supported. JSON lines files should be encoded using UTF-8. Use of Byte-Order-Mark (BOM) encoded files isn't officially supported by the JSON RFC spec, and Azure OpenAI will currently treat BOM encoded files as invalid. A UTF-8-BOM encoded file will currently return the generic error message: "Validation failed: A valid model deployment name couldn't be extracted from the input file. Please ensure that each row in the input file has a valid deployment name specified in the 'model' field, and that the deployment name is consistent across all rows."
 
 ## See also

Summary

{
    "modification_type": "minor update",
    "modification_title": "バッチ処理ドキュメントの更新"
}

Explanation

この変更は、「batch.md」というファイルの更新を示しています。文中のいくつかの表現が修正され、特にフレーズがより明確で一貫性のあるものに変更されました。具体的には、処理時間やキャンセルの手続きに関する説明が調整され、最新のAPIリリース情報が更新されました。また、注意書きが追加され、特定のモデルが新しいプレビューAPIバージョンを必要とすることが強調されています。さらに、UTF-8-BOMエンコードされたjsonlファイルに関する記述も修正され、エラーメッセージの内容がより正確に説明されています。これにより、ユーザーはバッチ処理の利用に関する重要な情報を、より正確で分かりやすい形で得ることができるようになります。

articles/ai-services/openai/includes/batch/batch-python.md

Diff

@@ -95,7 +95,7 @@ token_provider = get_bearer_token_provider(
 client = AzureOpenAI(
   azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT"), 
   azure_ad_token_provider=token_provider,
-  api_version="2024-10-21"
+  api_version="2025-03-01-preview"
 )
 
 # Upload a file with a purpose of "batch"
@@ -118,7 +118,7 @@ from openai import AzureOpenAI
     
 client = AzureOpenAI(
     api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2024-10-21",
+    api_version="2025-03-01-preview",
     azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
     )
 
@@ -441,7 +441,7 @@ token_credential = DefaultAzureCredential()
 token = token_credential.get_token('https://cognitiveservices.azure.com/.default')
 
 endpoint = "https://{YOUR_RESOURCE_NAME}.openai.azure.com/"
-api_version = "2024-10-01-preview"
+api_version = "2025-03-01-preview"
 url = f"{endpoint}openai/batches"
 order = "created_at asc"
 time_filter =  lambda: generate_time_filter("past 8 hours")
@@ -502,7 +502,7 @@ from datetime import datetime, timedelta
 
 api_key = os.getenv("AZURE_OPENAI_API_KEY"),  
 endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
-api_version = "2024-10-01-preview"
+api_version = "2025-03-01-preview"
 url = f"{endpoint}openai/batches"
 order = "created_at asc"

Summary

{
    "modification_type": "minor update",
    "modification_title": "バッチ処理用PythonコードのAPIバージョン更新"
}

Explanation

この変更は、「batch-python.md」というファイルの内容を更新し、使用されるAPIバージョンを新しいプレビュー版「2025-03-01-preview」に変更しています。具体的には、複数の場所でapi_versionの値が更新され、最新のAPI機能や修正点に対応できるようになっています。この変更により、開発者は最新のAPIを利用したバッチ処理の実装を行うことが可能となり、将来の機能強化や安全性の向上を活用できるようになります。また、これに伴い、ドキュメントが最新のAPIに関する正確な情報を反映することが保証され、ユーザーの理解を深める手助けとなります。

articles/ai-services/openai/includes/batch/batch-rest.md

Diff

@@ -74,7 +74,7 @@ Once your input file is prepared, you first need to upload the file to then be a
 [!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 ```http
-curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files?api-version=2024-10-21 \
+curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files?api-version=2025-03-01-preview \
   -H "Content-Type: multipart/form-data" \
   -H "api-key: $AZURE_OPENAI_API_KEY" \
   -F "purpose=batch" \
@@ -104,7 +104,7 @@ The above code assumes a particular file path for your test.jsonl file. Adjust t
 Depending on the size of your upload file it might take some time before it's fully uploaded and processed. To check on your file upload status run:
 
 ```http
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{file-id}?api-version=2024-10-21 \
+curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{file-id}?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY"
 ```
 
@@ -128,7 +128,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{file-id}?api-vers
 Once your file has uploaded successfully you can submit the file for batch processing.
 
 ```http
-curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2024-10-21 \
+curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{
@@ -177,7 +177,7 @@ curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-vers
 Once you have created batch job successfully you can monitor its progress either in the Studio or programatically. When checking batch job progress we recommend waiting at least 60 seconds in between each status call.
 
 ```http
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches/{batch_id}?api-version=2024-10-21 \
+curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches/{batch_id}?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
 ```
 
@@ -229,7 +229,7 @@ The following status values are possible:
 ## Retrieve batch job output file
 
 ```http
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{output_file_id}/content?api-version=2024-10-21 \
+curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{output_file_id}/content?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY" > batch_output.jsonl
 ```
 
@@ -240,7 +240,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{output_file_id}/c
 Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.
 
 ```http
-curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches/{batch_id}/cancel?api-version=2024-10-21 \
+curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches/{batch_id}/cancel?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
 ```
 
@@ -249,7 +249,7 @@ curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches/{batch_i
 List existing batch jobs for a given Azure OpenAI resource.
 
 ```http
-curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2024-10-21 \
+curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2025-03-01-preview \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
 ```
 
@@ -262,7 +262,7 @@ The list API call is paginated. The response contains a boolean `has_more` to in
 Use the REST API to list all batch jobs with additional sorting/filtering options.
 
 ```http
-curl "YOUR_RESOURCE_NAME.openai.azure.com/batches?api-version=2024-10-01-preview&$filter=created_at%20gt%201728773533%20and%20created_at%20lt%201729032733%20and%20status%20eq%20'Completed'&$orderby=created_at%20asc" \
+curl "YOUR_RESOURCE_NAME.openai.azure.com/batches?api-version=2025-03-01-preview&$filter=created_at%20gt%201728773533%20and%20created_at%20lt%201729032733%20and%20status%20eq%20'Completed'&$orderby=created_at%20asc" \
   -H "api-key: $AZURE_OPENAI_API_KEY"
 ```

Summary

{
    "modification_type": "minor update",
    "modification_title": "バッチ処理APIのバージョン更新"
}

Explanation

この変更は、「batch-rest.md」というファイルに対するもので、Azure OpenAIサービスのバッチ処理に関連するAPIのバージョンを「2025-03-01-preview」に更新しています。具体的には、ファイルのアップロード、バッチ処理の開始、進行状況のチェック、結果の取得、バッチのキャンセル、および既存のバッチジョブのリスト化の各プロセスに関連するcurlコマンドのapi-versionがすべて変更されています。この修正により、ユーザーは新しいAPIバージョンの機能を利用できるようになり、最新のエンドポイントと仕様に基づいた正確な情報をもとにバッチ処理を実行することが可能になります。この更新は、ドキュメントの整合性とユーザーエクスペリエンスの向上に寄与します。

articles/ai-services/openai/includes/model-matrix/datazone-standard.md

Diff

@@ -6,7 +6,7 @@ manager: nitinme
 ms.service: azure-ai-openai
 ms.topic: include
 ms.custom: references_regions
-ms.date: 03/19/2025
+ms.date: 04/02/2025
 ---
 
 | **Region**     | **o3-mini**, **2025-01-31**   | **o1**, **2024-12-17**   | **gpt-4o**, **2024-05-13**   | **gpt-4o**, **2024-08-06**   | **gpt-4o**, **2024-11-20**   | **gpt-4o-mini**, **2024-07-18**   |
@@ -15,6 +15,7 @@ ms.date: 03/19/2025
 | eastus2            | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |
 | francecentral      | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |
 | germanywestcentral | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |
+| italynorth         | ✅                        | ✅                   | -                      | -                      | ✅                       | ✅                            |
 | northcentralus     | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |
 | polandcentral      | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |
 | southcentralus     | ✅                        | ✅                   | ✅                       | ✅                       | ✅                       | ✅                            |

Summary

{
    "modification_type": "minor update",
    "modification_title": "データゾーンの標準モデルマトリックスの更新"
}

Explanation

この変更は、「datazone-standard.md」というファイルにおける微細な修正を含んでいます。主な変更点として、ドキュメントの日付が「2025年3月19日」から「2025年4月2日」に更新され、また新たに「italynorth」リージョンがモデルマトリックスに追加されました。この新しいリージョンは、特定のモデルに対するサポート状況を示すチェックマーク（✅）とともに記載されています。これにより、ユーザーはイタリアの北部におけるモデルサポートの状況も把握できるようになります。この更新は、モデルの展開状況に関する情報の正確さを向上させ、利用者が地理的な選択肢をより効果的に理解する手助けとなります。

articles/ai-services/openai/includes/model-matrix/standard-global.md

Diff

@@ -6,31 +6,32 @@ manager: nitinme
 ms.service: azure-ai-openai
 ms.topic: include
 ms.custom: references_regions
-ms.date: 03/13/2025
+ms.date: 04/02/2025
 ---
 
-| **Region**     | **o3-mini**, **2025-01-31**   | **o1**, **2024-12-17**   | **o1-preview**, **2024-09-12**   | **o1-mini**, **2024-09-12**   | **gpt-4o**, **2024-05-13**   | **gpt-4o**, **2024-08-06**   | **gpt-4o**, **2024-11-20**   | **gpt-4o-mini**, **2024-07-18**   | **gpt-4o-realtime-preview**, **2024-12-17**   | **gpt-4o-audio-preview**, **2024-12-17**   | **gpt-4o-mini-realtime-preview**, **2024-12-17**   | **gpt-4o-mini-audio-preview**, **2024-12-17**   | **gpt-4**, **turbo-2024-04-09**   | **text-embedding-3-small**, **1**   | **text-embedding-3-large**, **1**   | **text-embedding-ada-002**, **2**   |
-|:-------------------|:---------------------------:|:----------------------:|:------------------------------:|:---------------------------:|:--------------------------:|:--------------------------:|:--------------------------:|:-------------------------------:|:-------------------------------------------:|:----------------------------------------:|:------------------------------------------------:|:---------------------------------------------:|:-------------------------------:|:---------------------------------:|:---------------------------------:|:---------------------------------:|
-| australiaeast      | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| brazilsouth        | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| canadaeast         | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| eastus             | -                       | -                  | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                          | ✅                            | ✅                              | ✅                              | ✅                              |
-| eastus2            | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | ✅                                        | ✅                                     | ✅                                             | ✅                                          | ✅                            | ✅                              | ✅                              | -                             |
-| francecentral      | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| germanywestcentral | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| japaneast          | -                       | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| koreacentral       | -                       | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| northcentralus     | -                       | -                  | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| norwayeast         | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| polandcentral      | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| southafricanorth   | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| southcentralus     | -                       | -                  | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | ✅                              |
-| southindia         | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| spaincentral       | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| swedencentral      | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | ✅                                        | ✅                                     | ✅                                             | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| switzerlandnorth   | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| uaenorth           | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| uksouth            | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| westeurope         | -                       | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| westus             | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
-| westus3            | -                       | -                  | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
\ No newline at end of file
+| **Region**     | **gpt-4.5-preview**, **2025-02-27**   | **o3-mini**, **2025-01-31**   | **o1**, **2024-12-17**   | **o1-preview**, **2024-09-12**   | **o1-mini**, **2024-09-12**   | **gpt-4o**, **2024-05-13**   | **gpt-4o**, **2024-08-06**   | **gpt-4o**, **2024-11-20**   | **gpt-4o-mini**, **2024-07-18**   | **gpt-4o-realtime-preview**, **2024-12-17**   | **gpt-4o-audio-preview**, **2024-12-17**   | **gpt-4o-mini-realtime-preview**, **2024-12-17**   | **gpt-4o-mini-audio-preview**, **2024-12-17**   | **gpt-4**, **turbo-2024-04-09**   | **text-embedding-3-small**, **1**   | **text-embedding-3-large**, **1**   | **text-embedding-ada-002**, **2**   |
+|:-------------------|:-----------------------------------:|:---------------------------:|:----------------------:|:------------------------------:|:---------------------------:|:--------------------------:|:--------------------------:|:--------------------------:|:-------------------------------:|:-------------------------------------------:|:----------------------------------------:|:------------------------------------------------:|:---------------------------------------------:|:-------------------------------:|:---------------------------------:|:---------------------------------:|:---------------------------------:|
+| australiaeast      | -                               | ✅                        | -                  | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| brazilsouth        | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| canadaeast         | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| eastus             | -                               | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | ✅                                          | ✅                            | ✅                              | ✅                              | ✅                              |
+| eastus2            | ✅                                | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | ✅                                        | ✅                                     | ✅                                             | ✅                                          | ✅                            | ✅                              | ✅                              | -                             |
+| francecentral      | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| germanywestcentral | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| italynorth         | -                               | ✅                        | ✅                   | -                          | -                       | -                      | -                      | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | -                           | -                             | -                             | -                             |
+| japaneast          | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| koreacentral       | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| northcentralus     | -                               | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| norwayeast         | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| polandcentral      | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| southafricanorth   | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| southcentralus     | -                               | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | ✅                              |
+| southindia         | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| spaincentral       | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| swedencentral      | ✅                                | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | ✅                                        | ✅                                     | ✅                                             | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| switzerlandnorth   | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| uaenorth           | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| uksouth            | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| westeurope         | -                               | ✅                        | ✅                   | -                          | -                       | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| westus             | -                               | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
+| westus3            | -                               | ✅                        | ✅                   | ✅                           | ✅                        | ✅                       | ✅                       | ✅                       | ✅                            | -                                       | -                                    | -                                            | -                                         | ✅                            | ✅                              | ✅                              | -                             |
\ No newline at end of file

Summary

{
    "modification_type": "minor update",
    "modification_title": "グローバルモデルマトリックスの更新"
}

Explanation

この変更は、「standard-global.md」というファイルに対して行われており、主として更新日の日付が「2025年3月13日」から「2025年4月2日」に変更されています。また、モデルマトリックスの内容が拡充されており、新たに「gpt-4.5-preview」モデルが追加されています。この新しいモデルは、各リージョンでの対応状況を反映したカラムとしてテーブルに加わり、具体的なサポートの可否を示しています。

これにより、ユーザーは新たに追加されたモデルの利用可能性を確認することができ、各リージョンにおけるモデルのサポート状況がより詳細に把握できるようになります。この更新は、AIサービスのページを訪れるユーザーにとって、最新の情報を提供し、選択肢の理解を深める助けになります。

articles/ai-services/openai/toc.yml

Diff

@@ -306,16 +306,16 @@ items:
       href: reference-preview.md
     - name: Assistants API Reference
       items:
-        - name: Python/REST
+        - name: REST
           items:
           - name: Assistants
-            href: ./assistants-reference.md
+            href: reference-preview.md#list---assistants
           - name: Threads
-            href: ./assistants-reference-threads.md
+            href: reference-preview.md#create---thread
           - name: Messages
-            href: ./assistants-reference-messages.md
+            href: reference-preview.md#list---messages
           - name: Runs
-            href: ./assistants-reference-runs.md 
+            href: reference-preview.md#create---thread-and-run
         - name: SDK 
           items:
           - name: C#
@@ -326,6 +326,8 @@ items:
             href: /java/api/overview/azure/ai-openai-assistants-readme?context=/azure/ai-services/openai/context/context
           - name: JavaScript
             href: /javascript/api/overview/azure/openai-assistants-readme?context=/azure/ai-services/openai/context/context
+          - name: Python
+            href: https://platform.openai.com/docs/api-reference/assistants
           
     - name: Azure OpenAI On Your Data API Reference
       items:

Summary

{
    "modification_type": "minor update",
    "modification_title": "TOCファイルの更新"
}

Explanation

この変更では、「toc.yml」ファイルに対していくつかの更新が行われています。主に、Assistants API Referenceセクションにおいて、いくつかの項目が修正され、リンク先が変更されました。具体的には、Python/RESTという名前がRESTに変更され、各項目のリンクが更新されています。例えば、Assistants、Threads、Messages、Runsに関連するリンクが、もとのローカルファイルへのリンクから、新しい「reference-preview.md」へのリンクに変更され、よりアクセスしやすい形になっています。

また、新たにPythonに関するリンクも追加され、OpenAIのAPIリファレンスに直接アクセスできるようになりました。この更新は、ユーザーがAPIリファレンスへ迅速かつ容易に移動できるようにし、作業の効率を向上させることを目的としています。全体的に、リンクの一貫性と明瞭性が強化された更新です。

Diff Insight Report - openai

新しい機能

破壊的変更

その他の更新

インサイト

Summary Table

Modified Contents

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

Summary

Explanation

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

Summary

Explanation

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

Summary

Explanation

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

Summary

Explanation

articles/ai-services/openai/how-to/batch.md

Summary

Explanation

articles/ai-services/openai/includes/batch/batch-python.md

Summary

Explanation

articles/ai-services/openai/includes/batch/batch-rest.md

Summary

Explanation

articles/ai-services/openai/includes/model-matrix/datazone-standard.md

Summary

Explanation

articles/ai-services/openai/includes/model-matrix/standard-global.md

Summary

Explanation

articles/ai-services/openai/toc.yml

Summary

Explanation