From bf137b8d7474d651906a2cd3dafac5144b59b643 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 18 Jun 2024 15:32:22 +0200 Subject: [PATCH 01/55] cleaned up config file --- specification/ai/OpenAI.Assistants/tspconfig.yaml | 12 ++++++------ .../assistants.json} | 0 .../assistants.json} | 0 .../assistants.yaml} | 0 .../assistants.yaml} | 0 5 files changed, 6 insertions(+), 6 deletions(-) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/{assistants_generated.json => generated/assistants.json} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/{assistants_generated.json => generated/assistants.json} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/{assistants_generated.yaml => generated/assistants.yaml} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/{assistants_generated.yaml => generated/assistants.yaml} (100%) diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index 564b8e16d05f..892aa9d47442 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -3,25 +3,25 @@ parameters: default: "sdk/openai" "dependencies": default: "" + output-folder-base: + default: "data-plane/OpenAI.Assistants/" emit: - "@azure-tools/typespec-autorest" - "@typespec/openapi3" -# - "@azure-tools/typespec-java" -# - "@azure-tools/typespec-csharp" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" options: "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "data-plane" - emit-lro-options: "none" emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV2/{version-status}/{version}/assistants_generated.json" + azure-resource-provider-folder: "data-plane" examples-directory: "{project-root}/examples" + output-file: "{output-folder-base}/OpenApiV2/{version-status}/{version}/generated/assistants.json" omit-unreachable-types: true + emit-lro-options: "none" "@typespec/openapi3": emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV3/{version}/assistants_generated.yaml" + output-file: "{output-folder-base}/OpenApiV3/{version}/generated/assistants.yaml" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.OpenAI.Assistants" namespace: "Azure.AI.OpenAI.Assistants" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/generated/assistants.json similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/generated/assistants.json diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/generated/assistants.json similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/generated/assistants.json diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/generated/assistants.yaml similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/generated/assistants.yaml diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/generated/assistants.yaml similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/generated/assistants.yaml From bcc78b8fca594fac7333c7f7e4d53acea80224d8 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 18 Jun 2024 19:27:19 +0200 Subject: [PATCH 02/55] reverted name --- specification/ai/OpenAI.Assistants/tspconfig.yaml | 4 ++-- .../{generated/assistants.json => assistants_generated.json} | 0 .../{generated/assistants.json => assistants_generated.json} | 0 .../{generated/assistants.yaml => assistants_generated.yaml} | 0 .../{generated/assistants.yaml => assistants_generated.yaml} | 0 5 files changed, 2 insertions(+), 2 deletions(-) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/{generated/assistants.json => assistants_generated.json} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/{generated/assistants.json => assistants_generated.json} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/{generated/assistants.yaml => assistants_generated.yaml} (100%) rename specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/{generated/assistants.yaml => assistants_generated.yaml} (100%) diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index 892aa9d47442..75c925ce08fa 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -16,12 +16,12 @@ options: emitter-output-dir: "{project-root}/../" azure-resource-provider-folder: "data-plane" examples-directory: "{project-root}/examples" - output-file: "{output-folder-base}/OpenApiV2/{version-status}/{version}/generated/assistants.json" + output-file: "{output-folder-base}/OpenApiV2/{version-status}/{version}/assistants_generated.json" omit-unreachable-types: true emit-lro-options: "none" "@typespec/openapi3": emitter-output-dir: "{project-root}/../" - output-file: "{output-folder-base}/OpenApiV3/{version}/generated/assistants.yaml" + output-file: "{output-folder-base}/OpenApiV3/{version}/assistants_generated.yaml" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.OpenAI.Assistants" namespace: "Azure.AI.OpenAI.Assistants" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/generated/assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/generated/assistants.json rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/generated/assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/generated/assistants.json rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/generated/assistants.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/generated/assistants.yaml rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/generated/assistants.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml similarity index 100% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/generated/assistants.yaml rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml From 051fe7926db4a37fc773c0f4cb1b487604cc9054 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 10:26:44 +0200 Subject: [PATCH 03/55] Restored names and verified example adding behaviour for openapi2 emitter --- .../examples/2024-02-15-preview/create_assistant.json | 2 +- .../examples/2024-05-01-preview/create_assistant.json | 2 +- .../preview/2024-02-15-preview/assistants_generated.json | 5 +++++ .../2024-02-15-preview/examples/create_assistant.json | 4 ++++ .../preview/2024-05-01-preview/assistants_generated.json | 5 +++++ .../2024-05-01-preview/examples/create_assistant.json | 4 ++++ 6 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 24f1208ac3df..1ded43078048 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -1,4 +1,4 @@ { "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "operationId": "CreateAssistant" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 24f1208ac3df..1ded43078048 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -1,4 +1,4 @@ { "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "operationId": "CreateAssistant" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index e1a20fe445e2..c7f5ab060810 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -187,6 +187,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Assistants_CreateAssistant": { + "$ref": "./examples/create_assistant.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json new file mode 100644 index 000000000000..1ded43078048 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -0,0 +1,4 @@ +{ + "title": "Assistants_CreateAssistant", + "operationId": "CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index b0fe2a911183..c6c61e2a7ace 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -187,6 +187,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Assistants_CreateAssistant": { + "$ref": "./examples/create_assistant.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..1ded43078048 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -0,0 +1,4 @@ +{ + "title": "Assistants_CreateAssistant", + "operationId": "CreateAssistant" +} From 5687feacfbc5dbed328cd14eb59dfb2552678f09 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 11:58:02 +0200 Subject: [PATCH 04/55] Added example JSON files and the readme file --- .../2024-02-15-preview/cancel_run.json | 37 ++++++ .../2024-02-15-preview/create_assistant.json | 42 ++++++- .../create_assistant_file.json | 21 ++++ .../2024-02-15-preview/create_message.json | 36 ++++++ .../2024-02-15-preview/create_run.json | 34 ++++++ .../2024-02-15-preview/create_thread.json | 17 +++ .../create_thread_and_run.json | 33 ++++++ .../2024-02-15-preview/delete_assistant.json | 17 +++ .../delete_assistant_file.json | 18 +++ .../2024-02-15-preview/delete_thread.json | 17 +++ .../get_assistant_file.json | 19 +++ .../2024-02-15-preview/get_message.json | 33 ++++++ .../2024-02-15-preview/get_message_file.json | 20 ++++ .../examples/2024-02-15-preview/get_run.json | 32 +++++ .../2024-02-15-preview/get_run_step.json | 40 +++++++ .../list_assistant_files.json | 26 ++++ .../2024-02-15-preview/list_assistants.json | 55 +++++++++ .../list_message_files.json | 33 ++++++ .../2024-02-15-preview/list_messages.json | 60 ++++++++++ .../2024-02-15-preview/list_run_steps.json | 47 ++++++++ .../2024-02-15-preview/list_runs.json | 39 ++++++ .../2024-02-15-preview/modify_assistant.json | 33 ++++++ .../2024-02-15-preview/modify_message.json | 42 +++++++ .../2024-02-15-preview/modify_run.json | 41 +++++++ .../2024-02-15-preview/modify_thread.json | 27 +++++ .../retrieve_assistant.json | 30 +++++ .../2024-02-15-preview/retrieve_thread.json | 18 +++ .../submit_tool_outputs_to_run.json | 68 +++++++++++ .../2024-05-01-preview/cancel_run.json | 46 +++++++ .../cancel_vector_store_file_batch.json | 27 +++++ .../2024-05-01-preview/create_assistant.json | 39 +++++- .../2024-05-01-preview/create_message.json | 36 ++++++ .../2024-05-01-preview/create_run.json | 49 ++++++++ .../2024-05-01-preview/create_thread.json | 17 +++ .../create_thread_and_run.json | 54 +++++++++ .../create_vector_store.json | 28 +++++ .../create_vector_store_file.json | 24 ++++ .../create_vector_store_file_batch.json | 30 +++++ .../2024-05-01-preview/delete_assistant.json | 17 +++ .../delete_assistant_file.json | 18 +++ .../2024-05-01-preview/delete_message.json | 18 +++ .../2024-05-01-preview/delete_thread.json | 17 +++ .../delete_vector_store.json | 17 +++ .../delete_vector_store_file.json | 18 +++ .../get_assistant_file.json | 19 +++ .../2024-05-01-preview/get_message.json | 33 ++++++ .../2024-05-01-preview/get_message_file.json | 20 ++++ .../examples/2024-05-01-preview/get_run.json | 32 +++++ .../2024-05-01-preview/get_run_step.json | 40 +++++++ .../list_assistant_files.json | 26 ++++ .../2024-05-01-preview/list_assistants.json | 70 +++++++++++ .../list_message_files.json | 33 ++++++ .../2024-05-01-preview/list_messages.json | 60 ++++++++++ .../2024-05-01-preview/list_run_steps.json | 47 ++++++++ .../2024-05-01-preview/list_runs.json | 112 ++++++++++++++++++ .../list_vector_store_file_batch.json | 33 ++++++ .../list_vector_store_files.json | 32 +++++ .../list_vector_stores.json | 47 ++++++++ .../2024-05-01-preview/modify_assistant.json | 44 +++++++ .../2024-05-01-preview/modify_message.json | 42 +++++++ .../2024-05-01-preview/modify_run.json | 66 +++++++++++ .../2024-05-01-preview/modify_thread.json | 28 +++++ .../modify_vector_store.json | 29 +++++ .../retrieve_assistant.json | 30 +++++ .../2024-05-01-preview/retrieve_message.json | 33 ++++++ .../2024-05-01-preview/retrieve_run.json | 51 ++++++++ .../2024-05-01-preview/retrieve_run_step.json | 40 +++++++ .../2024-05-01-preview/retrieve_thread.json | 23 ++++ .../retrieve_vector_store.json | 17 +++ .../retrieve_vector_store_file.json | 21 ++++ .../retrieve_vector_store_file_batch.json | 27 +++++ .../submit_tool_outputs_to_run.json | 77 ++++++++++++ .../ai/data-plane/OpenAI.Assistants/readme.md | 29 +++++ 73 files changed, 2547 insertions(+), 4 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/readme.md diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json new file mode 100644 index 000000000000..1ae47c75eb57 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -0,0 +1,37 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 1ded43078048..cb6924ff4488 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -1,4 +1,42 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview", + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json new file mode 100644 index 000000000000..caac97728edc --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json @@ -0,0 +1,21 @@ +{ + "title": "Create an assistant file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "body": { + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + } + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json new file mode 100644 index 000000000000..8603319ccfb0 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json new file mode 100644 index 000000000000..03ae58f607b7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -0,0 +1,34 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json new file mode 100644 index 000000000000..a89dea899924 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json new file mode 100644 index 000000000000..8b7a5ad25176 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -0,0 +1,33 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json new file mode 100644 index 000000000000..33041a9a2100 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json new file mode 100644 index 000000000000..39858bd9f0c0 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json new file mode 100644 index 000000000000..1e40049a8911 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json new file mode 100644 index 000000000000..983d370def4b --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json new file mode 100644 index 000000000000..f3dfad66bae6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json new file mode 100644 index 000000000000..23b1dd7589d2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json new file mode 100644 index 000000000000..634725381947 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json new file mode 100644 index 000000000000..94d2d0cae97a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json new file mode 100644 index 000000000000..23421c112439 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json new file mode 100644 index 000000000000..96a01837c500 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json @@ -0,0 +1,55 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-mMGvtln6ieqP5DhoFo5vpZge" + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json new file mode 100644 index 000000000000..1736bf7b5c3f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json new file mode 100644 index 000000000000..e2d1fffa2569 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json new file mode 100644 index 000000000000..d2b91fdb8038 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json new file mode 100644 index 000000000000..9628a46faa00 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json new file mode 100644 index 000000000000..34a04cc23e0d --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "body": { + "model": "gpt-35-turbo-1106" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-35-turbo-1106", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json new file mode 100644 index 000000000000..7edde508a520 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json new file mode 100644 index 000000000000..968f3e824dd8 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json @@ -0,0 +1,41 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json new file mode 100644 index 000000000000..f9846880c299 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json @@ -0,0 +1,27 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json new file mode 100644 index 000000000000..9206c6315b09 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json new file mode 100644 index 000000000000..e0f557584dbe --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..802078c38aba --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,68 @@ +{ + "title": "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.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json new file mode 100644 index 000000000000..7e3aca79645a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -0,0 +1,46 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [ + "vs_123" + ] + } + }, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..8938d19e5eb5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 1ded43078048..90a84050feae 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -1,4 +1,39 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json new file mode 100644 index 000000000000..3daba6884a32 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json new file mode 100644 index 000000000000..66be66e700e4 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -0,0 +1,49 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json new file mode 100644 index 000000000000..9a2c9a0562c9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json new file mode 100644 index 000000000000..498485d16158 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json new file mode 100644 index 000000000000..5a68896c3eba --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json @@ -0,0 +1,28 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "body": { + "name": "Support FAQ" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json new file mode 100644 index 000000000000..362b97f6f6eb --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json @@ -0,0 +1,24 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json new file mode 100644 index 000000000000..4f495f7d4faa --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -0,0 +1,30 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json new file mode 100644 index 000000000000..28fbaae51958 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json new file mode 100644 index 000000000000..d65fcfd03103 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json new file mode 100644 index 000000000000..c5d8b3fb5522 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json new file mode 100644 index 000000000000..a8f646110535 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json new file mode 100644 index 000000000000..9a985f6a32b9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json new file mode 100644 index 000000000000..508b70795867 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json new file mode 100644 index 000000000000..0f04fecb406a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json new file mode 100644 index 000000000000..eae6a039a3ee --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json new file mode 100644 index 000000000000..3cf33e449c63 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json new file mode 100644 index 000000000000..0e3dc7c97e1e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json new file mode 100644 index 000000000000..2c6848498591 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json new file mode 100644 index 000000000000..ebee97920e61 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json new file mode 100644 index 000000000000..2b109f123efe --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json @@ -0,0 +1,70 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json new file mode 100644 index 000000000000..2fa7877bae8d --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json new file mode 100644 index 000000000000..54ec320629a1 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json new file mode 100644 index 000000000000..3d6708e83edd --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json new file mode 100644 index 000000000000..9649dbb6e4e4 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -0,0 +1,112 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json new file mode 100644 index 000000000000..9e097fa77a64 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of vector store files in a batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json new file mode 100644 index 000000000000..6b75de46f17a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -0,0 +1,32 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json new file mode 100644 index 000000000000..06ec7d5f5e8a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json new file mode 100644 index 000000000000..ed4ad5cb3796 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json @@ -0,0 +1,44 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_abc123", + "body": { + "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": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "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": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json new file mode 100644 index 000000000000..15e33c9b849b --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "file_ids": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json new file mode 100644 index 000000000000..284e7e98e049 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json @@ -0,0 +1,66 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json new file mode 100644 index 000000000000..05b6a770d2ad --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json new file mode 100644 index 000000000000..e45794b4a12a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json new file mode 100644 index 000000000000..7e2049802b5e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "tools": [ + { + "type": "file_search" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json new file mode 100644 index 000000000000..52b602a9ee6b --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieves a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json new file mode 100644 index 000000000000..f69fd90f5c8f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -0,0 +1,51 @@ +{ + "title": "Retrieves a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json new file mode 100644 index 000000000000..348a30e52023 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json new file mode 100644 index 000000000000..59efa4f93fef --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json new file mode 100644 index 000000000000..a2fdbc47ad1c --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776 + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json new file mode 100644 index 000000000000..8ae3bcaec94f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json @@ -0,0 +1,21 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json new file mode 100644 index 000000000000..5c864a0c40b7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + } +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..1f5c0c21c609 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,77 @@ +{ + "title": "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.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_123", + "run_id": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md new file mode 100644 index 000000000000..2b236dd21a19 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -0,0 +1,29 @@ +# AI OpenAI.Assistants SDK + +> see https://aka.ms/autorest + +Configuration for generating AzureOpenAI Inference SDK. + +The current release for the AzureOpenAI is `release_2024_05_01`. + +``` yaml +tag: release_2023_05_15 +add-credentials: true +openapi-type: data-plane +``` + +# Releases + +## OpenAI.Assistants 2024-02-15-preview (generated) +These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_15_preview_autogen' +input-file: preview/2024-02-15-preview/generated.json +``` + +## OpenAI.Assistants 2024-05-01-preview (generated) +These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_05_01_preview_autogen' +input-file: preview/2024-05-01-preview/generated.json +``` From 104438431e936cbb45eb33cd4516fcc14a50f431 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 12:16:09 +0200 Subject: [PATCH 05/55] Added examples for past releases --- .../2024-02-15-preview/cancel_run.json | 5 +- .../2024-02-15-preview/create_assistant.json | 5 +- .../create_assistant_file.json | 5 +- .../2024-02-15-preview/create_message.json | 5 +- .../2024-02-15-preview/create_run.json | 5 +- .../2024-02-15-preview/create_thread.json | 5 +- .../create_thread_and_run.json | 5 +- .../2024-02-15-preview/delete_assistant.json | 5 +- .../delete_assistant_file.json | 5 +- .../2024-02-15-preview/delete_thread.json | 5 +- .../get_assistant_file.json | 5 +- .../2024-02-15-preview/get_message.json | 5 +- .../2024-02-15-preview/get_message_file.json | 5 +- .../examples/2024-02-15-preview/get_run.json | 5 +- .../2024-02-15-preview/get_run_step.json | 5 +- .../list_assistant_files.json | 5 +- .../2024-02-15-preview/list_assistants.json | 5 +- .../list_message_files.json | 5 +- .../2024-02-15-preview/list_messages.json | 5 +- .../2024-02-15-preview/list_run_steps.json | 5 +- .../2024-02-15-preview/list_runs.json | 5 +- .../2024-02-15-preview/modify_assistant.json | 5 +- .../2024-02-15-preview/modify_message.json | 5 +- .../2024-02-15-preview/modify_run.json | 5 +- .../2024-02-15-preview/modify_thread.json | 5 +- .../retrieve_assistant.json | 5 +- .../2024-02-15-preview/retrieve_thread.json | 5 +- .../submit_tool_outputs_to_run.json | 5 +- .../2024-05-01-preview/cancel_run.json | 5 +- .../cancel_vector_store_file_batch.json | 5 +- .../2024-05-01-preview/create_assistant.json | 5 +- .../2024-05-01-preview/create_message.json | 5 +- .../2024-05-01-preview/create_run.json | 5 +- .../2024-05-01-preview/create_thread.json | 5 +- .../create_thread_and_run.json | 5 +- .../create_vector_store.json | 5 +- .../create_vector_store_file.json | 5 +- .../create_vector_store_file_batch.json | 5 +- .../2024-05-01-preview/delete_assistant.json | 5 +- .../delete_assistant_file.json | 5 +- .../2024-05-01-preview/delete_message.json | 5 +- .../2024-05-01-preview/delete_thread.json | 5 +- .../delete_vector_store.json | 5 +- .../delete_vector_store_file.json | 5 +- .../get_assistant_file.json | 5 +- .../2024-05-01-preview/get_message.json | 5 +- .../2024-05-01-preview/get_message_file.json | 5 +- .../examples/2024-05-01-preview/get_run.json | 5 +- .../2024-05-01-preview/get_run_step.json | 5 +- .../list_assistant_files.json | 5 +- .../2024-05-01-preview/list_assistants.json | 5 +- .../list_message_files.json | 5 +- .../2024-05-01-preview/list_messages.json | 5 +- .../2024-05-01-preview/list_run_steps.json | 5 +- .../2024-05-01-preview/list_runs.json | 5 +- .../list_vector_store_file_batch.json | 5 +- .../list_vector_store_files.json | 5 +- .../list_vector_stores.json | 5 +- .../2024-05-01-preview/modify_assistant.json | 5 +- .../2024-05-01-preview/modify_message.json | 5 +- .../2024-05-01-preview/modify_run.json | 5 +- .../2024-05-01-preview/modify_thread.json | 5 +- .../modify_vector_store.json | 5 +- .../retrieve_assistant.json | 5 +- .../2024-05-01-preview/retrieve_message.json | 5 +- .../2024-05-01-preview/retrieve_run.json | 5 +- .../2024-05-01-preview/retrieve_run_step.json | 5 +- .../2024-05-01-preview/retrieve_thread.json | 5 +- .../retrieve_vector_store.json | 5 +- .../retrieve_vector_store_file.json | 5 +- .../retrieve_vector_store_file_batch.json | 5 +- .../submit_tool_outputs_to_run.json | 5 +- .../examples/add_operation_id.py | 35 +++++ .../assistants_generated.json | 77 ++++++++++- .../examples/cancel_run.json | 38 ++++++ .../examples/create_assistant.json | 43 +++++- .../examples/create_message.json | 37 ++++++ .../examples/create_run.json | 35 +++++ .../examples/create_thread.json | 18 +++ .../examples/create_thread_and_run.json | 34 +++++ .../examples/delete_assistant.json | 18 +++ .../examples/delete_thread.json | 18 +++ .../examples/get_message.json | 34 +++++ .../2024-02-15-preview/examples/get_run.json | 33 +++++ .../examples/get_run_step.json | 41 ++++++ .../examples/list_assistants.json | 56 ++++++++ .../examples/list_messages.json | 61 +++++++++ .../examples/list_run_steps.json | 48 +++++++ .../examples/list_runs.json | 40 ++++++ .../examples/submit_tool_outputs_to_run.json | 69 ++++++++++ .../assistants_generated.json | 122 +++++++++++++++++- .../examples/cancel_run.json | 47 +++++++ .../cancel_vector_store_file_batch.json | 28 ++++ .../examples/create_assistant.json | 40 +++++- .../examples/create_message.json | 37 ++++++ .../examples/create_run.json | 50 +++++++ .../examples/create_thread.json | 18 +++ .../examples/create_thread_and_run.json | 55 ++++++++ .../examples/create_vector_store.json | 29 +++++ .../examples/create_vector_store_file.json | 25 ++++ .../create_vector_store_file_batch.json | 31 +++++ .../examples/delete_assistant.json | 18 +++ .../examples/delete_thread.json | 18 +++ .../examples/delete_vector_store.json | 18 +++ .../examples/delete_vector_store_file.json | 19 +++ .../examples/get_message.json | 34 +++++ .../2024-05-01-preview/examples/get_run.json | 33 +++++ .../examples/get_run_step.json | 41 ++++++ .../examples/list_assistants.json | 71 ++++++++++ .../examples/list_messages.json | 61 +++++++++ .../examples/list_run_steps.json | 48 +++++++ .../examples/list_runs.json | 113 ++++++++++++++++ .../examples/list_vector_store_files.json | 33 +++++ .../examples/list_vector_stores.json | 48 +++++++ .../examples/modify_vector_store.json | 30 +++++ .../examples/submit_tool_outputs_to_run.json | 78 +++++++++++ 116 files changed, 2090 insertions(+), 150 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/add_operation_id.py create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 1ae47c75eb57..e0c3b0ed3fb9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -33,5 +33,6 @@ "usage": null } } - } -} + }, + "operationId": "CancelRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index cb6924ff4488..f11e44bbfb6f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -38,5 +38,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json index caac97728edc..0c8e29c2ac94 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json @@ -17,5 +17,6 @@ "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" } } - } -} + }, + "operationId": "CreateAssistantFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index 8603319ccfb0..3325b3654177 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -32,5 +32,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index 03ae58f607b7..a2917edefe91 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -30,5 +30,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json index a89dea899924..cb1e87fce7b8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json @@ -13,5 +13,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index 8b7a5ad25176..564a64e920e6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -29,5 +29,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateThreadAndRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json index 33041a9a2100..3acec83decb3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json @@ -13,5 +13,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json index 39858bd9f0c0..3441e64ee68a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json @@ -14,5 +14,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteAssistantFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json index 1e40049a8911..8c5abe1c5c70 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json @@ -13,5 +13,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json index 983d370def4b..adaf818b0d67 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json @@ -15,5 +15,6 @@ "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" } } - } -} + }, + "operationId": "GetAssistantFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index f3dfad66bae6..c74194211093 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -29,5 +29,6 @@ "metadata": {} } } - } -} + }, + "operationId": "GetMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json index 23b1dd7589d2..273d292e2286 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json @@ -16,5 +16,6 @@ "message_id": "msg_abc123" } } - } -} + }, + "operationId": "GetMessageFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index 634725381947..6bf2173f08a5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -28,5 +28,6 @@ "metadata": {} } } - } -} + }, + "operationId": "GetRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json index 94d2d0cae97a..56a3a74724c8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json @@ -36,5 +36,6 @@ } } } - } -} + }, + "operationId": "GetRunStep" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json index 23421c112439..f4b3a7a9e6a0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json @@ -22,5 +22,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListAssistantFiles" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json index 96a01837c500..795a313c1a22 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json @@ -51,5 +51,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListAssistants" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json index 1736bf7b5c3f..4590f712a037 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json @@ -29,5 +29,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListMessageFiles" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index e2d1fffa2569..4681c826eed5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -56,5 +56,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListMessages" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json index d2b91fdb8038..b3e7f75d7f87 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json @@ -43,5 +43,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListRunSteps" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index 9628a46faa00..36f76639da53 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -35,5 +35,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListRuns" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json index 34a04cc23e0d..09e0ea093ac0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json @@ -29,5 +29,6 @@ "metadata": {} } } - } -} + }, + "operationId": "ModifyAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json index 7edde508a520..2656218af6ad 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json @@ -38,5 +38,6 @@ } } } - } -} + }, + "operationId": "ModifyMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json index 968f3e824dd8..9888b7b5ceff 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json @@ -37,5 +37,6 @@ } } } - } -} + }, + "operationId": "ModifyRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json index f9846880c299..b188338a5a49 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json @@ -23,5 +23,6 @@ } } } - } -} + }, + "operationId": "ModifyThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json index 9206c6315b09..7600d92f0a2e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json @@ -26,5 +26,6 @@ "metadata": {} } } - } -} + }, + "operationId": "RetrieveAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json index e0f557584dbe..753af1048e60 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json @@ -14,5 +14,6 @@ "metadata": {} } } - } -} + }, + "operationId": "RetrieveThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index 802078c38aba..3aab0016231e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -64,5 +64,6 @@ "usage": null } } - } -} + }, + "operationId": "SubmitToolOutputsToRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index 7e3aca79645a..ea8e1ca1ee2e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -42,5 +42,6 @@ "response_format": "auto" } } - } -} + }, + "operationId": "CancelRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json index 8938d19e5eb5..3d492a3bea29 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -23,5 +23,6 @@ } } } - } -} + }, + "operationId": "CancelVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 90a84050feae..01fba179d09b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -35,5 +35,6 @@ "response_format": "auto" } } - } -} + }, + "operationId": "CreateAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index 3daba6884a32..fb4ecb80c7f6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -32,5 +32,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 66be66e700e4..c3a23a8129ff 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -45,5 +45,6 @@ "tool_choice": "auto" } } - } -} + }, + "operationId": "CreateRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json index 9a2c9a0562c9..ffc483236436 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -13,5 +13,6 @@ "metadata": {} } } - } -} + }, + "operationId": "CreateThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 498485d16158..c67e85fbd7d2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -50,5 +50,6 @@ "tool_choice": "auto" } } - } -} + }, + "operationId": "CreateThreadAndRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json index 5a68896c3eba..463f69000d18 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json @@ -24,5 +24,6 @@ } } } - } -} + }, + "operationId": "CreateVectorStore" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json index 362b97f6f6eb..d70d6788c5f6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json @@ -20,5 +20,6 @@ "last_error": null } } - } -} + }, + "operationId": "CreateVectorStoreFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json index 4f495f7d4faa..42e85d14c474 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -26,5 +26,6 @@ "total": 0 } } - } -} + }, + "operationId": "CreateVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json index 28fbaae51958..c6e1241e3828 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json @@ -13,5 +13,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json index d65fcfd03103..58af130970e4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json @@ -14,5 +14,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteAssistantFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json index c5d8b3fb5522..8e094454cf8b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json @@ -14,5 +14,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json index a8f646110535..ca40acfcd819 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json @@ -13,5 +13,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json index 9a985f6a32b9..a4ab908cc51b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json @@ -13,5 +13,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteVectorStore" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json index 508b70795867..4c0f2edeab29 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json @@ -14,5 +14,6 @@ "deleted": true } } - } -} + }, + "operationId": "DeleteVectorStoreFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json index 0f04fecb406a..b89adb764a2c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json @@ -15,5 +15,6 @@ "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" } } - } -} + }, + "operationId": "GetAssistantFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index eae6a039a3ee..d0872836f9da 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -29,5 +29,6 @@ "metadata": {} } } - } -} + }, + "operationId": "GetMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json index 3cf33e449c63..a3f365ff39dc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json @@ -16,5 +16,6 @@ "message_id": "msg_abc123" } } - } -} + }, + "operationId": "GetMessageFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 0e3dc7c97e1e..0d0b0d0195b8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -28,5 +28,6 @@ "metadata": {} } } - } -} + }, + "operationId": "GetRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json index 2c6848498591..74cee430ceac 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -36,5 +36,6 @@ } } } - } -} + }, + "operationId": "GetRunStep" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json index ebee97920e61..837f7ee7186f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json @@ -22,5 +22,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListAssistantFiles" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json index 2b109f123efe..d7d6ba0fa12d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json @@ -66,5 +66,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListAssistants" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json index 2fa7877bae8d..f52196d97367 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json @@ -29,5 +29,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListMessageFiles" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index 54ec320629a1..e087fd6b1a35 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -56,5 +56,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListMessages" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json index 3d6708e83edd..83071db8914c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -43,5 +43,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListRunSteps" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 9649dbb6e4e4..864713d3f352 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -108,5 +108,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListRuns" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json index 9e097fa77a64..de31c186d977 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json @@ -29,5 +29,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json index 6b75de46f17a..1dc2091e1178 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -28,5 +28,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListVectorStoreFiles" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json index 06ec7d5f5e8a..34ace65ede87 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json @@ -43,5 +43,6 @@ "has_more": false } } - } -} + }, + "operationId": "ListVectorStores" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json index ed4ad5cb3796..6a112cd4a8d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json @@ -40,5 +40,6 @@ "response_format": "auto" } } - } -} + }, + "operationId": "ModifyAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json index 15e33c9b849b..86e98b3cae31 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json @@ -38,5 +38,6 @@ } } } - } -} + }, + "operationId": "ModifyMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json index 284e7e98e049..ae584dcba811 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json @@ -62,5 +62,6 @@ "tool_choice": "auto" } } - } -} + }, + "operationId": "ModifyRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json index 05b6a770d2ad..0d4a0e3e03d7 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json @@ -24,5 +24,6 @@ "tool_resources": {} } } - } -} + }, + "operationId": "ModifyThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json index e45794b4a12a..e410a04e82a9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json @@ -25,5 +25,6 @@ } } } - } -} + }, + "operationId": "ModifyVectorStore" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json index 7e2049802b5e..9b660a7393c3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json @@ -26,5 +26,6 @@ "response_format": "auto" } } - } -} + }, + "operationId": "RetrieveAssistant" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json index 52b602a9ee6b..372a25ccb600 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json @@ -29,5 +29,6 @@ "metadata": {} } } - } -} + }, + "operationId": "RetrieveMessage" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index f69fd90f5c8f..0ec1a07f3837 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -47,5 +47,6 @@ "tool_choice": "auto" } } - } -} + }, + "operationId": "RetrieveRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json index 348a30e52023..9aafcb1f6ebd 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json @@ -36,5 +36,6 @@ } } } - } -} + }, + "operationId": "RetrieveRunStep" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json index 59efa4f93fef..31c9b1ffe6cf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json @@ -19,5 +19,6 @@ } } } - } -} + }, + "operationId": "RetrieveThread" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json index a2fdbc47ad1c..f900cd7c2016 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json @@ -13,5 +13,6 @@ "created_at": 1699061776 } } - } -} + }, + "operationId": "RetrieveVectorStore" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json index 8ae3bcaec94f..b170465f678f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json @@ -17,5 +17,6 @@ "last_error": null } } - } -} + }, + "operationId": "RetrieveVectorStoreFile" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json index 5c864a0c40b7..0dd6c8938111 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json @@ -23,5 +23,6 @@ } } } - } -} + }, + "operationId": "RetrieveVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index 1f5c0c21c609..f4c096450604 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -73,5 +73,6 @@ "tool_choice": "auto" } } - } -} + }, + "operationId": "SubmitToolOutputsToRun" +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/add_operation_id.py b/specification/ai/OpenAI.Assistants/examples/add_operation_id.py new file mode 100644 index 000000000000..bfdaca48b511 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/add_operation_id.py @@ -0,0 +1,35 @@ +#!/usr/bin/env python3 + +import json +import pathlib + +# Function to convert snake case to Pascal case +def snake_to_pascal(name): + # Split the name by underscores, capitalize each word, then join them together + return ''.join(word.title() for word in name.split('_')) + +# Define the base path as the current directory +base_path = pathlib.Path('.') +# Define the versions of the JSON files to process +versions = ['2024-02-15-preview', '2024-05-01-preview'] + +# Loop over each version +for version in versions: + # Loop over each JSON file in the current version directory + for json_file in (base_path / version).glob('*.json'): + print(f"Processing file: {json_file}") # Print the file being processed + try: + # Open the JSON file and load its contents + with json_file.open() as f: + data = json.load(f) + + # Convert the file name (without extension) from snake case to Pascal case + operation_id = snake_to_pascal(json_file.stem) + # Add the operation ID to the JSON data + data['operationId'] = operation_id + + # Open the JSON file again (in write mode this time) and write the updated data + with json_file.open('w') as f: + json.dump(data, f, indent=2) + except Exception as e: + print(f"Error processing file {json_file}: {e}") # Print any errors that occurls diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index c7f5ab060810..c047072ab0d0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -189,7 +194,7 @@ } }, "x-ms-examples": { - "Assistants_CreateAssistant": { + "Create an assistant with a model and instructions.": { "$ref": "./examples/create_assistant.json" } } @@ -261,6 +266,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -478,6 +488,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -547,6 +562,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -663,6 +683,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -684,6 +709,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -714,6 +744,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -876,6 +911,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -906,6 +946,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -936,6 +981,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -1012,6 +1062,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1135,6 +1190,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1172,6 +1232,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1229,6 +1294,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "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.\n": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1253,6 +1323,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json new file mode 100644 index 000000000000..e0c3b0ed3fb9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -0,0 +1,38 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "CancelRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index 1ded43078048..f11e44bbfb6f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -1,4 +1,43 @@ { - "title": "Assistants_CreateAssistant", + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview", + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + }, "operationId": "CreateAssistant" -} +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json new file mode 100644 index 000000000000..3325b3654177 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -0,0 +1,37 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json new file mode 100644 index 000000000000..a2917edefe91 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -0,0 +1,35 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + }, + "operationId": "CreateRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json new file mode 100644 index 000000000000..cb1e87fce7b8 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..564a64e920e6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -0,0 +1,34 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + }, + "operationId": "CreateThreadAndRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..3acec83decb3 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json new file mode 100644 index 000000000000..8c5abe1c5c70 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json new file mode 100644 index 000000000000..c74194211093 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -0,0 +1,34 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json new file mode 100644 index 000000000000..6bf2173f08a5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -0,0 +1,33 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json new file mode 100644 index 000000000000..56a3a74724c8 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json @@ -0,0 +1,41 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + }, + "operationId": "GetRunStep" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json new file mode 100644 index 000000000000..795a313c1a22 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json @@ -0,0 +1,56 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-mMGvtln6ieqP5DhoFo5vpZge" + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json new file mode 100644 index 000000000000..4681c826eed5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -0,0 +1,61 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..b3e7f75d7f87 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json @@ -0,0 +1,48 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json new file mode 100644 index 000000000000..36f76639da53 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..3aab0016231e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,69 @@ +{ + "title": "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.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index c6c61e2a7ace..92c8e375fabd 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -189,7 +194,7 @@ } }, "x-ms-examples": { - "Assistants_CreateAssistant": { + "Create an assistant with a model and instructions.": { "$ref": "./examples/create_assistant.json" } } @@ -261,6 +266,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -514,6 +524,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -583,6 +598,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -706,6 +726,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -736,6 +761,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -766,6 +796,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -928,6 +963,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -958,6 +998,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -988,6 +1033,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -1064,6 +1114,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1187,6 +1242,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1224,6 +1284,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1281,6 +1346,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "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.\n": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1305,6 +1375,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } }, @@ -1414,6 +1489,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } } }, "post": { @@ -1436,6 +1516,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Creates a vector store.": { + "$ref": "./examples/create_vector_store.json" + } } } }, @@ -1488,6 +1573,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Modifies a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } } }, "delete": { @@ -1509,6 +1599,11 @@ "$ref": "#/definitions/VectorStoreDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } } } }, @@ -1555,6 +1650,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } } } }, @@ -1615,6 +1715,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } } } }, @@ -1932,6 +2037,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } } }, "post": { @@ -1971,6 +2081,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Create a vector store file by attaching a File to a vector store.": { + "$ref": "./examples/create_vector_store_file.json" + } } } }, @@ -2029,6 +2144,11 @@ "$ref": "#/definitions/VectorStoreFileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.": { + "$ref": "./examples/delete_vector_store_file.json" + } } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..ea8e1ca1ee2e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -0,0 +1,47 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [ + "vs_123" + ] + } + }, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CancelRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..3d492a3bea29 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + }, + "operationId": "CancelVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json index 1ded43078048..01fba179d09b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -1,4 +1,40 @@ { - "title": "Assistants_CreateAssistant", + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, "operationId": "CreateAssistant" -} +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json new file mode 100644 index 000000000000..fb4ecb80c7f6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -0,0 +1,37 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json new file mode 100644 index 000000000000..c3a23a8129ff --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -0,0 +1,50 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..ffc483236436 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..c67e85fbd7d2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -0,0 +1,55 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateThreadAndRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..463f69000d18 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json @@ -0,0 +1,29 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "body": { + "name": "Support FAQ" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "CreateVectorStore" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..d70d6788c5f6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,25 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "CreateVectorStoreFile" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..42e85d14c474 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,31 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + }, + "operationId": "CreateVectorStoreFileBatch" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..c6e1241e3828 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..ca40acfcd819 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..a4ab908cc51b --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStore" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..4c0f2edeab29 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,19 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStoreFile" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json new file mode 100644 index 000000000000..d0872836f9da --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -0,0 +1,34 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json new file mode 100644 index 000000000000..0d0b0d0195b8 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -0,0 +1,33 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..74cee430ceac --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json @@ -0,0 +1,41 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + }, + "operationId": "GetRunStep" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..d7d6ba0fa12d --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json @@ -0,0 +1,71 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..e087fd6b1a35 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -0,0 +1,61 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..83071db8914c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json @@ -0,0 +1,48 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..864713d3f352 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -0,0 +1,113 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..1dc2091e1178 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..34ace65ede87 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json @@ -0,0 +1,48 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStores" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..e410a04e82a9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json @@ -0,0 +1,30 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "ModifyVectorStore" +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..f4c096450604 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,78 @@ +{ + "title": "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.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_123", + "run_id": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} \ No newline at end of file From 059ed393560354b19fcaba96d9ab1269d838d53c Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 12:21:28 +0200 Subject: [PATCH 06/55] Added more documentation to the script --- .../ai/OpenAI.Assistants/examples/add_operation_id.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/ai/OpenAI.Assistants/examples/add_operation_id.py b/specification/ai/OpenAI.Assistants/examples/add_operation_id.py index bfdaca48b511..a0d06a05da39 100644 --- a/specification/ai/OpenAI.Assistants/examples/add_operation_id.py +++ b/specification/ai/OpenAI.Assistants/examples/add_operation_id.py @@ -3,6 +3,9 @@ import json import pathlib +# README: this script assumes you are running it from OpenAI.Assistants/examples +# USAGE: run the command `py .\add_operatio_id.py` + # Function to convert snake case to Pascal case def snake_to_pascal(name): # Split the name by underscores, capitalize each word, then join them together From 5f533825f3ca1dc7d0383568ab9771929f9ef1bf Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 14:03:32 +0200 Subject: [PATCH 07/55] Readme corrections --- specification/ai/data-plane/OpenAI.Assistants/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md index 2b236dd21a19..81f80ec48b6a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/readme.md +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -18,12 +18,12 @@ openapi-type: data-plane These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. ``` yaml $(tag) == 'release_2024_02_15_preview_autogen' -input-file: preview/2024-02-15-preview/generated.json +input-file: preview/2024-02-15-preview/assistants_generated.json ``` ## OpenAI.Assistants 2024-05-01-preview (generated) These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. ``` yaml $(tag) == 'release_2024_05_01_preview_autogen' -input-file: preview/2024-05-01-preview/generated.json +input-file: preview/2024-05-01-preview/assistants_generated.json ``` From 16b0ba3b1fdede2ad29e00a4e4c01d64fe7a723d Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 14:05:27 +0200 Subject: [PATCH 08/55] More readme corrections --- specification/ai/data-plane/OpenAI.Assistants/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md index 81f80ec48b6a..d4fcc01f7383 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/readme.md +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -18,12 +18,12 @@ openapi-type: data-plane These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. ``` yaml $(tag) == 'release_2024_02_15_preview_autogen' -input-file: preview/2024-02-15-preview/assistants_generated.json +input-file: OpenApiV2/preview/2024-02-15-preview/assistants_generated.json ``` ## OpenAI.Assistants 2024-05-01-preview (generated) These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. ``` yaml $(tag) == 'release_2024_05_01_preview_autogen' -input-file: preview/2024-05-01-preview/assistants_generated.json +input-file: OpenApiV2/preview/2024-05-01-preview/assistants_generated.json ``` From 08dc0913055cde31b8313ed8392486bc5565555e Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 19 Jun 2024 16:05:29 +0200 Subject: [PATCH 09/55] Renamed retrieveAssistants examples to getAssistants to match TSP definition --- ...ieve_assistant.json => get_assistant.json} | 4 +-- ...ieve_assistant.json => get_assistant.json} | 4 +-- .../assistants_generated.json | 5 +++ .../examples/get_assistant.json | 31 +++++++++++++++++++ .../assistants_generated.json | 5 +++ .../examples/get_assistant.json | 31 +++++++++++++++++++ 6 files changed, 76 insertions(+), 4 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{retrieve_assistant.json => get_assistant.json} (95%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{retrieve_assistant.json => get_assistant.json} (95%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json similarity index 95% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json index 7600d92f0a2e..46832f98b33d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json @@ -27,5 +27,5 @@ } } }, - "operationId": "RetrieveAssistant" -} \ No newline at end of file + "operationId": "GetAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json similarity index 95% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json index 9b660a7393c3..86d60911fd43 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json @@ -27,5 +27,5 @@ } } }, - "operationId": "RetrieveAssistant" -} \ No newline at end of file + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index c047072ab0d0..6cff7c51a05f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -220,6 +220,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json new file mode 100644 index 000000000000..46832f98b33d --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 92c8e375fabd..ab0db325dff1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -220,6 +220,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json new file mode 100644 index 000000000000..86d60911fd43 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "tools": [ + { + "type": "file_search" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "GetAssistant" +} From 6d29d3b18d6279d02107960c69c6e1937e750130 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 11:26:52 +0200 Subject: [PATCH 10/55] Removed some swagger files --- .../assistants_generated.json | 3452 ----------------- .../examples/create_assistant.json | 15 +- .../2023-11-06-beta/assistants_generated.json | 3452 ----------------- .../examples/create_assistant.json | 4 - .../assistants_generated.yaml | 2388 ------------ .../2023-11-06-beta/assistants_generated.yaml | 2388 ------------ 6 files changed, 8 insertions(+), 11691 deletions(-) delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json deleted file mode 100644 index 436e3f654419..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-02-15-preview", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index f11e44bbfb6f..c7194aef700a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -20,9 +20,9 @@ "responses": { "200": { "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "id": "asst_8C0bDx4L3X8feuHyS9IXH4kU", "object": "assistant", - "created_at": 1707295707, + "created_at": 1718811879, "name": "Math Tutor", "description": null, "model": "gpt-4-1106-preview", @@ -32,12 +32,13 @@ "type": "code_interpreter" } ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], - "metadata": {} + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" } } }, "operationId": "CreateAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json deleted file mode 100644 index 7b5bd59f8c14..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-11-06-beta", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json deleted file mode 100644 index 24f1208ac3df..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml deleted file mode 100644 index 8a83ec762134..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-02-15-preview - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-02-15-preview - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml deleted file mode 100644 index ee485d79df7c..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-11-06-beta - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: 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. - schema: - type: string - - name: before - in: query - required: false - description: 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. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-11-06-beta - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. From f1b397510ffad8e0faba8c5972da0165341cce25 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 11:44:18 +0200 Subject: [PATCH 11/55] create_assistants json corrections --- .../2024-02-15-preview/create_assistant.json | 48 +++++++++---------- .../2024-05-01-preview/create_assistant.json | 2 +- .../examples/create_assistant.json | 47 ++++++++---------- .../examples/create_assistant.json | 2 +- 4 files changed, 45 insertions(+), 54 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index f11e44bbfb6f..1d7c6d0022d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -7,37 +7,33 @@ "name": "Math Tutor", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ - { - "type": "code_interpreter" - } + { + "type": "code_interpreter" + } ], - "model": "gpt-4-1106-preview", - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ] + "model": "gpt-4-1106-preview" } }, "responses": { "200": { - "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", - "object": "assistant", - "created_at": 1707295707, - "name": "Math Tutor", - "description": null, - "model": "gpt-4-1106-preview", - "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", - "tools": [ - { - "type": "code_interpreter" - } - ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], - "metadata": {} - } + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" } }, "operationId": "CreateAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 01fba179d09b..69f66a84e09d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -37,4 +37,4 @@ } }, "operationId": "CreateAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index c7194aef700a..1d7c6d0022d5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -7,37 +7,32 @@ "name": "Math Tutor", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ - { - "type": "code_interpreter" - } + { + "type": "code_interpreter" + } ], - "model": "gpt-4-1106-preview", - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ] + "model": "gpt-4-1106-preview" } }, "responses": { "200": { - "body": { - "id": "asst_8C0bDx4L3X8feuHyS9IXH4kU", - "object": "assistant", - "created_at": 1718811879, - "name": "Math Tutor", - "description": null, - "model": "gpt-4-1106-preview", - "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", - "tools": [ - { - "type": "code_interpreter" - } - ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" - } + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" } }, "operationId": "CreateAssistant" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json index 01fba179d09b..69f66a84e09d 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -37,4 +37,4 @@ } }, "operationId": "CreateAssistant" -} \ No newline at end of file +} From 1d2f7606b7373c62a89002bb8c31d468795ba8cc Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 11:50:01 +0200 Subject: [PATCH 12/55] wip --- .../2024-02-15-preview/create_assistant.json | 36 ++++++++++--------- .../examples/create_assistant.json | 36 ++++++++++--------- 2 files changed, 38 insertions(+), 34 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 1d7c6d0022d5..dd3af6ce590f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -16,23 +16,25 @@ }, "responses": { "200": { - "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", - "object": "assistant", - "created_at": 1718875084, - "name": "Math Tutor", - "description": null, - "model": "gpt-4-1106-preview", - "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", - "tools": [ - { - "type": "code_interpreter" - } - ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" + } } }, "operationId": "CreateAssistant" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index 1d7c6d0022d5..dd3af6ce590f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -16,23 +16,25 @@ }, "responses": { "200": { - "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", - "object": "assistant", - "created_at": 1718875084, - "name": "Math Tutor", - "description": null, - "model": "gpt-4-1106-preview", - "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", - "tools": [ - { - "type": "code_interpreter" - } - ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" + } } }, "operationId": "CreateAssistant" From b9cc526841e83b2c35fda57138698b2a736cd62a Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 11:53:42 +0200 Subject: [PATCH 13/55] Get Assistants --- .../2024-02-15-preview/get_assistant.json | 13 +++++++------ .../2024-05-01-preview/get_assistant.json | 15 ++++++++------- .../examples/get_assistant.json | 13 +++++++------ .../examples/get_assistant.json | 15 ++++++++------- 4 files changed, 30 insertions(+), 26 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json index 46832f98b33d..81804e467909 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json @@ -8,9 +8,9 @@ "responses": { "200": { "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1707295707, + "created_at": 1718875084, "name": "Math Tutor", "description": null, "model": "gpt-4-1106-preview", @@ -20,10 +20,11 @@ "type": "code_interpreter" } ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], - "metadata": {} + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json index 86d60911fd43..b45c802b706e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json @@ -8,21 +8,22 @@ "responses": { "200": { "body": { - "id": "asst_abc123", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1699009709, - "name": "HR Helper", + "created_at": 1718875084, + "name": "Math Tutor", "description": null, - "model": "gpt-4-turbo", - "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ { - "type": "file_search" + "type": "code_interpreter" } ], - "metadata": {}, "top_p": 1.0, "temperature": 1.0, + "file_ids": [], + "metadata": {}, "response_format": "auto" } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json index 46832f98b33d..81804e467909 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json @@ -8,9 +8,9 @@ "responses": { "200": { "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1707295707, + "created_at": 1718875084, "name": "Math Tutor", "description": null, "model": "gpt-4-1106-preview", @@ -20,10 +20,11 @@ "type": "code_interpreter" } ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], - "metadata": {} + "top_p": 1.0, + "temperature": 1.0, + "file_ids": [], + "metadata": {}, + "response_format": "auto" } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json index 86d60911fd43..b45c802b706e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json @@ -8,21 +8,22 @@ "responses": { "200": { "body": { - "id": "asst_abc123", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1699009709, - "name": "HR Helper", + "created_at": 1718875084, + "name": "Math Tutor", "description": null, - "model": "gpt-4-turbo", - "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ { - "type": "file_search" + "type": "code_interpreter" } ], - "metadata": {}, "top_p": 1.0, "temperature": 1.0, + "file_ids": [], + "metadata": {}, "response_format": "auto" } } From ef1e98cda01932a2ed2855e7ea89666a70c32d01 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 14:04:53 +0200 Subject: [PATCH 14/55] WIP --- .../2024-02-15-preview/create_assistant.json | 6 +-- .../2024-02-15-preview/get_assistant.json | 8 +--- .../2024-02-15-preview/list_assistants.json | 6 +-- .../2024-02-15-preview/modify_assistant.json | 4 +- .../2024-05-01-preview/modify_assistant.json | 4 +- .../assistants_generated.json | 5 +++ .../examples/create_assistant.json | 6 +-- .../examples/get_assistant.json | 8 +--- .../examples/list_assistants.json | 6 +-- .../examples/modify_assistant.json | 34 ++++++++++++++ .../assistants_generated.json | 5 +++ .../examples/modify_assistant.json | 45 +++++++++++++++++++ 12 files changed, 101 insertions(+), 36 deletions(-) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index dd3af6ce590f..5653c6dbc3e4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -29,11 +29,7 @@ "type": "code_interpreter" } ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "metadata": {} } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json index 81804e467909..09fa93da8abc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -20,11 +20,7 @@ "type": "code_interpreter" } ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "metadata": {} } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json index 795a313c1a22..56f32fa4007a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json @@ -24,9 +24,6 @@ "type": "code_interpreter" } ], - "file_ids": [ - "assistant-mMGvtln6ieqP5DhoFo5vpZge" - ], "metadata": {} }, { @@ -42,7 +39,6 @@ "type": "code_interpreter" } ], - "file_ids": [], "metadata": {} } ], @@ -53,4 +49,4 @@ } }, "operationId": "ListAssistants" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json index 09e0ea093ac0..329c638945ec 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json @@ -30,5 +30,5 @@ } } }, - "operationId": "ModifyAssistant" -} \ No newline at end of file + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json index 6a112cd4a8d5..d04bb4d5989f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json @@ -41,5 +41,5 @@ } } }, - "operationId": "ModifyAssistant" -} \ No newline at end of file + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 6cff7c51a05f..0f43127b7acb 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -250,6 +250,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index dd3af6ce590f..5653c6dbc3e4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -29,11 +29,7 @@ "type": "code_interpreter" } ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "metadata": {} } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json index 81804e467909..09fa93da8abc 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -20,11 +20,7 @@ "type": "code_interpreter" } ], - "top_p": 1.0, - "temperature": 1.0, - "file_ids": [], - "metadata": {}, - "response_format": "auto" + "metadata": {} } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json index 795a313c1a22..56f32fa4007a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json @@ -24,9 +24,6 @@ "type": "code_interpreter" } ], - "file_ids": [ - "assistant-mMGvtln6ieqP5DhoFo5vpZge" - ], "metadata": {} }, { @@ -42,7 +39,6 @@ "type": "code_interpreter" } ], - "file_ids": [], "metadata": {} } ], @@ -53,4 +49,4 @@ } }, "operationId": "ListAssistants" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..329c638945ec --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json @@ -0,0 +1,34 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "body": { + "model": "gpt-35-turbo-1106" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-35-turbo-1106", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index ab0db325dff1..eab14373ed67 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -250,6 +250,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..d04bb4d5989f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json @@ -0,0 +1,45 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistant_id": "asst_abc123", + "body": { + "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": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "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": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "UpdateAssistant" +} From d1abb2b310c1bedad39d72e16331990c27d3d9bd Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 15:11:58 +0200 Subject: [PATCH 15/55] File operations --- .../2024-02-15-preview/delete_assistant.json | 4 +- .../2024-02-15-preview/delete_file.json | 18 +++++++++ .../examples/2024-02-15-preview/get_file.json | 23 +++++++++++ .../2024-02-15-preview/get_file_content.json | 20 ++++++++++ .../2024-02-15-preview/list_file.json | 38 +++++++++++++++++++ .../2024-02-15-preview/modify_assistant.json | 15 +++----- .../2024-02-15-preview/upload_file.json | 30 +++++++++++++++ .../assistants_generated.json | 25 ++++++++++++ .../examples/delete_assistant.json | 4 +- .../examples/delete_file.json | 18 +++++++++ .../2024-02-15-preview/examples/get_file.json | 23 +++++++++++ .../examples/get_file_content.json | 20 ++++++++++ .../examples/list_file.json | 38 +++++++++++++++++++ .../examples/modify_assistant.json | 15 +++----- .../examples/upload_file.json | 30 +++++++++++++++ 15 files changed, 299 insertions(+), 22 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json index 3acec83decb3..f300dfb2ad72 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json new file mode 100644 index 000000000000..d17671ae3533 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json @@ -0,0 +1,20 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": [ + 0, + 1, + 0, + 1, + 0 + ] + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json new file mode 100644 index 000000000000..4ee91830a5af --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" + } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json index 329c638945ec..5fbe6b043ad1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json @@ -3,29 +3,26 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "assistant_id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "body": { - "model": "gpt-35-turbo-1106" + "name": "Math Tutor Improved" } }, "responses": { "200": { "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1707295707, - "name": "Math Tutor", + "created_at": 1718875084, + "name": "Math Tutor Improved", "description": null, - "model": "gpt-35-turbo-1106", + "model": "gpt-4-1106-preview", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ { "type": "code_interpreter" } ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json new file mode 100644 index 000000000000..2fa62ef91af8 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 0f43127b7acb..8e3f277461b3 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -336,6 +336,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -406,6 +411,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -429,6 +439,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -450,6 +465,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, @@ -474,6 +494,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json index 3acec83decb3..f300dfb2ad72 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json new file mode 100644 index 000000000000..d17671ae3533 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json @@ -0,0 +1,20 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": [ + 0, + 1, + 0, + 1, + 0 + ] + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json new file mode 100644 index 000000000000..4ee91830a5af --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" + } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json index 329c638945ec..5fbe6b043ad1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json @@ -3,29 +3,26 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "assistant_id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "body": { - "model": "gpt-35-turbo-1106" + "name": "Math Tutor Improved" } }, "responses": { "200": { "body": { - "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "object": "assistant", - "created_at": 1707295707, - "name": "Math Tutor", + "created_at": 1718875084, + "name": "Math Tutor Improved", "description": null, - "model": "gpt-35-turbo-1106", + "model": "gpt-4-1106-preview", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ { "type": "code_interpreter" } ], - "file_ids": [ - "assistant-0GeMWRaTlEASVHujzBXIcvbo" - ], "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json new file mode 100644 index 000000000000..2fa62ef91af8 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} From 53432310ccf0afbd32268061318f2be42f2af8fc Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 15:22:52 +0200 Subject: [PATCH 16/55] Files JSON examples --- .../examples/2024-02-15-preview/get_file.json | 4 +- .../2024-02-15-preview/get_file_content.json | 10 +---- .../2024-02-15-preview/list_file.json | 8 +--- ...y_assistant.json => update_assistant.json} | 2 +- .../2024-02-15-preview/upload_file.json | 4 +- .../examples/2024-05-01-preview/get_file.json | 23 +++++++++++ .../2024-05-01-preview/get_file_content.json | 12 ++++++ .../2024-05-01-preview/list_file.json | 38 +++++++++++++++++++ .../2024-05-01-preview/upload_file.json | 30 +++++++++++++++ .../assistants_generated.json | 2 +- .../2024-02-15-preview/examples/get_file.json | 4 +- .../examples/get_file_content.json | 10 +---- .../examples/list_file.json | 8 +--- .../examples/update_assistant.json | 31 +++++++++++++++ .../examples/upload_file.json | 4 +- .../assistants_generated.json | 20 ++++++++++ .../2024-05-01-preview/examples/get_file.json | 23 +++++++++++ .../examples/get_file_content.json | 12 ++++++ .../examples/list_file.json | 38 +++++++++++++++++++ .../examples/upload_file.json | 30 +++++++++++++++ 20 files changed, 269 insertions(+), 44 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{modify_assistant.json => update_assistant.json} (93%) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json index af3ab4586d76..c0a99d1b7a24 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json @@ -13,9 +13,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json index d17671ae3533..e289bbea96ba 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json @@ -6,15 +6,7 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": { - "body": [ - 0, - 1, - 0, - 1, - 0 - ] - } + "200": "file content" }, "operationId": "GetFileContent" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json index 4ee91830a5af..77c101dcb045 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json @@ -16,9 +16,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 }, { "object": "file", @@ -26,9 +24,7 @@ "purpose": "assistants", "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", "bytes": 4, - "created_at": 1718886043, - "status": "processed", - "status_details": null + "created_at": 1718886043 } ] } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json similarity index 93% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json index 5fbe6b043ad1..f0fb253c5f64 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "assistant_id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", "body": { "name": "Math Tutor Improved" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json index 2fa62ef91af8..94fd2039a6db 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json @@ -20,9 +20,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json new file mode 100644 index 000000000000..f6c330a22999 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json @@ -0,0 +1,12 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": "file content" + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json new file mode 100644 index 000000000000..8ad3b6699500 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" + } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 8e3f277461b3..e2d55c6bf330 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -253,7 +253,7 @@ }, "x-ms-examples": { "Modifies an assistant.": { - "$ref": "./examples/modify_assistant.json" + "$ref": "./examples/update_assistant.json" } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json index af3ab4586d76..c0a99d1b7a24 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json @@ -13,9 +13,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json index d17671ae3533..e289bbea96ba 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json @@ -6,15 +6,7 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": { - "body": [ - 0, - 1, - 0, - 1, - 0 - ] - } + "200": "file content" }, "operationId": "GetFileContent" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json index 4ee91830a5af..77c101dcb045 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json @@ -16,9 +16,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 }, { "object": "file", @@ -26,9 +24,7 @@ "purpose": "assistants", "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", "bytes": 4, - "created_at": 1718886043, - "status": "processed", - "status_details": null + "created_at": 1718886043 } ] } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json new file mode 100644 index 000000000000..f0fb253c5f64 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "body": { + "name": "Math Tutor Improved" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor Improved", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json index 2fa62ef91af8..94fd2039a6db 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json @@ -20,9 +20,7 @@ "purpose": "assistants", "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null + "created_at": 1718886199 } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index eab14373ed67..54c042293786 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -354,6 +354,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -442,6 +447,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -465,6 +475,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -510,6 +525,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..f6c330a22999 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json @@ -0,0 +1,12 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": "file content" + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json new file mode 100644 index 000000000000..8ad3b6699500 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" + } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} From 941f3cd3b1e505499eb380f2dc47740dc1084f69 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 15:30:43 +0200 Subject: [PATCH 17/55] wip --- .../examples/2024-05-01-preview/get_file_content.json | 4 +++- .../preview/2024-05-01-preview/examples/get_file_content.json | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json index f6c330a22999..4b5fec6d67f7 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json @@ -6,7 +6,9 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": "file content" + "200": { + "body": "file content" + } }, "operationId": "GetFileContent" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json index f6c330a22999..4b5fec6d67f7 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json @@ -6,7 +6,9 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": "file content" + "200": { + "body": "file content" + } }, "operationId": "GetFileContent" } From fe0963cf47385d5963aa7860c8e71dbdc544c553 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 16:04:37 +0200 Subject: [PATCH 18/55] wip --- .../2024-02-15-preview/create_thread.json | 5 ++-- .../2024-02-15-preview/get_file_content.json | 4 ++- .../{retrieve_thread.json => get_thread.json} | 4 +-- ...{modify_thread.json => update_thread.json} | 4 +-- .../2024-05-01-preview/create_thread.json | 5 ++-- .../{retrieve_thread.json => get_thread.json} | 4 +-- ...{modify_thread.json => update_thread.json} | 4 +-- .../assistants_generated.json | 10 +++++++ .../examples/create_thread.json | 5 ++-- .../examples/get_file_content.json | 4 ++- .../examples/get_thread.json | 19 ++++++++++++ .../examples/update_thread.json | 28 ++++++++++++++++++ .../assistants_generated.json | 10 +++++++ .../examples/create_thread.json | 5 ++-- .../examples/get_thread.json | 24 +++++++++++++++ .../examples/update_thread.json | 29 +++++++++++++++++++ 16 files changed, 146 insertions(+), 18 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{retrieve_thread.json => get_thread.json} (91%) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{modify_thread.json => update_thread.json} (94%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{retrieve_thread.json => get_thread.json} (93%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{modify_thread.json => update_thread.json} (94%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json index cb1e87fce7b8..9b2b9a3a463c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json @@ -2,7 +2,8 @@ "title": "Creates a thread.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview" + "api-version": "2024-02-15-preview", + "body": {} }, "responses": { "200": { @@ -15,4 +16,4 @@ } }, "operationId": "CreateThread" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json index e289bbea96ba..9f05e09e75d2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json @@ -6,7 +6,9 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": "file content" + "200": { + "body": "file content" + } }, "operationId": "GetFileContent" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json similarity index 91% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json index 753af1048e60..6dd5e2c99f95 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/retrieve_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json @@ -15,5 +15,5 @@ } } }, - "operationId": "RetrieveThread" -} \ No newline at end of file + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json similarity index 94% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json index b188338a5a49..3647b3a18776 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json @@ -24,5 +24,5 @@ } } }, - "operationId": "ModifyThread" -} \ No newline at end of file + "operationId": "UpdateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json index ffc483236436..25dc7e42c5e2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -2,7 +2,8 @@ "title": "Creates a thread.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview" + "api-version": "2024-05-01-preview", + "body": {} }, "responses": { "200": { @@ -15,4 +16,4 @@ } }, "operationId": "CreateThread" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json similarity index 93% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json index 31c9b1ffe6cf..7f7637e54d59 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json @@ -20,5 +20,5 @@ } } }, - "operationId": "RetrieveThread" -} \ No newline at end of file + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json similarity index 94% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json index 0d4a0e3e03d7..3a2fe6a44924 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json @@ -25,5 +25,5 @@ } } }, - "operationId": "ModifyThread" -} \ No newline at end of file + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index e2d55c6bf330..7180a6ccf25c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -551,6 +551,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -576,6 +581,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json index cb1e87fce7b8..9b2b9a3a463c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json @@ -2,7 +2,8 @@ "title": "Creates a thread.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview" + "api-version": "2024-02-15-preview", + "body": {} }, "responses": { "200": { @@ -15,4 +16,4 @@ } }, "operationId": "CreateThread" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json index e289bbea96ba..9f05e09e75d2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json @@ -6,7 +6,9 @@ "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" }, "responses": { - "200": "file content" + "200": { + "body": "file content" + } }, "operationId": "GetFileContent" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json new file mode 100644 index 000000000000..6dd5e2c99f95 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json new file mode 100644 index 000000000000..3647b3a18776 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 54c042293786..71b38202a1e9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -582,6 +582,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -607,6 +612,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json index ffc483236436..25dc7e42c5e2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json @@ -2,7 +2,8 @@ "title": "Creates a thread.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview" + "api-version": "2024-05-01-preview", + "body": {} }, "responses": { "200": { @@ -15,4 +16,4 @@ } }, "operationId": "CreateThread" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json new file mode 100644 index 000000000000..7f7637e54d59 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json @@ -0,0 +1,24 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json new file mode 100644 index 000000000000..3a2fe6a44924 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + }, + "operationId": "UpdateThread" +} From 9d4023abe7b32c6492efc997f30be896e5d05e8a Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 17:29:22 +0200 Subject: [PATCH 19/55] More various fixes --- .../examples/2024-02-15-preview/cancel_run.json | 8 ++++---- .../2024-02-15-preview/create_message.json | 9 ++++++--- .../examples/2024-02-15-preview/create_run.json | 7 ++++--- .../examples/2024-02-15-preview/delete_thread.json | 4 ++-- .../examples/2024-02-15-preview/get_message.json | 11 +++++++---- .../examples/2024-02-15-preview/get_run.json | 9 +++++---- .../examples/2024-02-15-preview/get_run_step.json | 11 ++++++----- .../examples/2024-02-15-preview/get_thread.json | 2 +- .../examples/2024-02-15-preview/list_messages.json | 14 ++++++++++---- .../2024-02-15-preview/list_run_steps.json | 9 +++++---- .../examples/2024-02-15-preview/list_runs.json | 11 ++++++++--- .../submit_tool_outputs_to_run.json | 6 +++--- .../examples/2024-02-15-preview/update_thread.json | 2 +- .../examples/2024-05-01-preview/cancel_run.json | 6 +++--- .../2024-05-01-preview/create_message.json | 8 ++++++-- .../examples/2024-05-01-preview/create_run.json | 4 ++-- .../examples/2024-05-01-preview/delete_thread.json | 4 ++-- .../examples/2024-05-01-preview/get_message.json | 11 +++++++---- .../examples/2024-05-01-preview/get_run.json | 9 +++++---- .../examples/2024-05-01-preview/get_run_step.json | 8 ++++---- .../examples/2024-05-01-preview/get_thread.json | 2 +- .../examples/2024-05-01-preview/list_messages.json | 4 ++-- .../2024-05-01-preview/list_run_steps.json | 6 +++--- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../submit_tool_outputs_to_run.json | 6 +++--- .../examples/2024-05-01-preview/update_thread.json | 2 +- .../2024-02-15-preview/examples/cancel_run.json | 8 ++++---- .../examples/create_message.json | 9 ++++++--- .../2024-02-15-preview/examples/create_run.json | 7 ++++--- .../2024-02-15-preview/examples/delete_thread.json | 4 ++-- .../2024-02-15-preview/examples/get_message.json | 11 +++++++---- .../2024-02-15-preview/examples/get_run.json | 9 +++++---- .../2024-02-15-preview/examples/get_run_step.json | 11 ++++++----- .../2024-02-15-preview/examples/get_thread.json | 2 +- .../2024-02-15-preview/examples/list_messages.json | 14 ++++++++++---- .../examples/list_run_steps.json | 9 +++++---- .../2024-02-15-preview/examples/list_runs.json | 11 ++++++++--- .../examples/submit_tool_outputs_to_run.json | 6 +++--- .../2024-02-15-preview/examples/update_thread.json | 2 +- .../2024-05-01-preview/examples/cancel_run.json | 6 +++--- .../examples/create_message.json | 8 ++++++-- .../2024-05-01-preview/examples/create_run.json | 4 ++-- .../2024-05-01-preview/examples/delete_thread.json | 4 ++-- .../2024-05-01-preview/examples/get_message.json | 11 +++++++---- .../2024-05-01-preview/examples/get_run.json | 9 +++++---- .../2024-05-01-preview/examples/get_run_step.json | 8 ++++---- .../2024-05-01-preview/examples/get_thread.json | 2 +- .../2024-05-01-preview/examples/list_messages.json | 4 ++-- .../examples/list_run_steps.json | 6 +++--- .../2024-05-01-preview/examples/list_runs.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 6 +++--- .../2024-05-01-preview/examples/update_thread.json | 2 +- 52 files changed, 206 insertions(+), 148 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index e0c3b0ed3fb9..5317d558935b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -28,11 +28,11 @@ "type": "code_interpreter" } ], - "file_ids": [], + "incomplete_details": null, "metadata": {}, "usage": null } } }, "operationId": "CancelRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index 3325b3654177..c0318a2f3364 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "role": "user", "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." @@ -26,7 +26,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -34,4 +37,4 @@ } }, "operationId": "CreateMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index a2917edefe91..b516adecefd2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", "body": { "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" } @@ -17,6 +17,8 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", + "incomplete_details": null, + "usage": null, "started_at": null, "expires_at": 1707301742, "cancelled_at": null, @@ -26,10 +28,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "CreateRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json index 8c5abe1c5c70..e14eac104c85 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteThread" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index c74194211093..20fd1c2f15c2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", - "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" }, "responses": { "200": { @@ -23,7 +23,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -31,4 +34,4 @@ } }, "operationId": "GetMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index 6bf2173f08a5..6dab7987a07e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -15,6 +15,8 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", + "incomplete_details": null, + "usage": null, "started_at": 1707303197, "expires_at": null, "cancelled_at": null, @@ -24,10 +26,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "GetRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json index 56a3a74724c8..5f74b0d0067a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json @@ -3,9 +3,9 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", - "step_id": "step_abc123" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" }, "responses": { "200": { @@ -33,9 +33,10 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } } }, "operationId": "GetRunStep" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json index 6dd5e2c99f95..b2c902c476aa 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index 4681c826eed5..20f01a6fda3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -25,7 +25,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", "metadata": {} @@ -45,7 +48,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -58,4 +64,4 @@ } }, "operationId": "ListMessages" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json index b3e7f75d7f87..7378eddd2de5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -35,7 +35,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } ], "first_id": "step_abc123", @@ -45,4 +46,4 @@ } }, "operationId": "ListRunSteps" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index 36f76639da53..c044c0365b3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV" + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" }, "responses": { "200": { @@ -26,7 +26,12 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, "metadata": {} } ], @@ -37,4 +42,4 @@ } }, "operationId": "ListRuns" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index 3aab0016231e..b6cf1b3a88b6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", "body": { "tool_outputs": [ { @@ -66,4 +66,4 @@ } }, "operationId": "SubmitToolOutputsToRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json index 3647b3a18776..af3b0ddfef32 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "metadata": { "modified": "true", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index ea8e1ca1ee2e..730bb59c4e1c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123" + "threadId": "thread_abc123", + "runId": "run_abc123" }, "responses": { "200": { @@ -44,4 +44,4 @@ } }, "operationId": "CancelRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index fb4ecb80c7f6..70ae2b1b9da1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "role": "user", "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." @@ -28,10 +28,14 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} } } }, "operationId": "CreateMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index c3a23a8129ff..28345b1bc1e0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", + "threadId": "thread_abc123", "body": { "assistant_id": "asst_abc123" } @@ -47,4 +47,4 @@ } }, "operationId": "CreateRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json index ca40acfcd819..fe2b6bc1b662 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteThread" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index d0872836f9da..d89c0c78aba2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", - "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" }, "responses": { "200": { @@ -23,7 +23,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -31,4 +34,4 @@ } }, "operationId": "GetMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 0d0b0d0195b8..938293c4fc60 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -15,6 +15,8 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", + "incomplete_details": null, + "usage": null, "started_at": 1707303197, "expires_at": null, "cancelled_at": null, @@ -24,10 +26,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "GetRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json index 74cee430ceac..31b0b668a594 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -3,9 +3,9 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", - "step_id": "step_abc123" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" }, "responses": { "200": { @@ -38,4 +38,4 @@ } }, "operationId": "GetRunStep" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json index 7f7637e54d59..8d95c82cfe2d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index e087fd6b1a35..fd90d3e4f9c7 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123" + "threadId": "thread_abc123" }, "responses": { "200": { @@ -58,4 +58,4 @@ } }, "operationId": "ListMessages" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json index 83071db8914c..3bf265748059 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123" + "threadId": "thread_abc123", + "runId": "run_abc123" }, "responses": { "200": { @@ -45,4 +45,4 @@ } }, "operationId": "ListRunSteps" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 864713d3f352..6aae5aba313e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123" + "threadId": "thread_abc123" }, "responses": { "200": { @@ -110,4 +110,4 @@ } }, "operationId": "ListRuns" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index f4c096450604..a53bc2d23bff 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_123", - "run_id": "run_123", + "threadId": "thread_123", + "runId": "run_123", "body": { "tool_outputs": [ { @@ -75,4 +75,4 @@ } }, "operationId": "SubmitToolOutputsToRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json index 3a2fe6a44924..e7610f8ec4cf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "metadata": { "modified": "true", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index e0c3b0ed3fb9..5317d558935b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -28,11 +28,11 @@ "type": "code_interpreter" } ], - "file_ids": [], + "incomplete_details": null, "metadata": {}, "usage": null } } }, "operationId": "CancelRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json index 3325b3654177..c0318a2f3364 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "role": "user", "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." @@ -26,7 +26,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -34,4 +37,4 @@ } }, "operationId": "CreateMessage" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index a2917edefe91..b516adecefd2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", "body": { "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" } @@ -17,6 +17,8 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", + "incomplete_details": null, + "usage": null, "started_at": null, "expires_at": 1707301742, "cancelled_at": null, @@ -26,10 +28,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "CreateRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json index 8c5abe1c5c70..e14eac104c85 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteThread" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json index c74194211093..20fd1c2f15c2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", - "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" }, "responses": { "200": { @@ -23,7 +23,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -31,4 +34,4 @@ } }, "operationId": "GetMessage" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index 6bf2173f08a5..6dab7987a07e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -15,6 +15,8 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", + "incomplete_details": null, + "usage": null, "started_at": 1707303197, "expires_at": null, "cancelled_at": null, @@ -24,10 +26,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "GetRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json index 56a3a74724c8..5f74b0d0067a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json @@ -3,9 +3,9 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", - "step_id": "step_abc123" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" }, "responses": { "200": { @@ -33,9 +33,10 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } } }, "operationId": "GetRunStep" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json index 6dd5e2c99f95..b2c902c476aa 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json index 4681c826eed5..20f01a6fda3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -25,7 +25,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", "metadata": {} @@ -45,7 +48,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -58,4 +64,4 @@ } }, "operationId": "ListMessages" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json index b3e7f75d7f87..7378eddd2de5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -35,7 +35,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } ], "first_id": "step_abc123", @@ -45,4 +46,4 @@ } }, "operationId": "ListRunSteps" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index 36f76639da53..c044c0365b3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV" + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" }, "responses": { "200": { @@ -26,7 +26,12 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, "metadata": {} } ], @@ -37,4 +42,4 @@ } }, "operationId": "ListRuns" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index 3aab0016231e..b6cf1b3a88b6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", "body": { "tool_outputs": [ { @@ -66,4 +66,4 @@ } }, "operationId": "SubmitToolOutputsToRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json index 3647b3a18776..af3b0ddfef32 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "metadata": { "modified": "true", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index ea8e1ca1ee2e..730bb59c4e1c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123" + "threadId": "thread_abc123", + "runId": "run_abc123" }, "responses": { "200": { @@ -44,4 +44,4 @@ } }, "operationId": "CancelRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json index fb4ecb80c7f6..70ae2b1b9da1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "role": "user", "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." @@ -28,10 +28,14 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} } } }, "operationId": "CreateMessage" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index c3a23a8129ff..28345b1bc1e0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", + "threadId": "thread_abc123", "body": { "assistant_id": "asst_abc123" } @@ -47,4 +47,4 @@ } }, "operationId": "CreateRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json index ca40acfcd819..fe2b6bc1b662 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteThread" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index d0872836f9da..d89c0c78aba2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", - "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" }, "responses": { "200": { @@ -23,7 +23,10 @@ } } ], - "file_ids": [], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "assistant_id": null, "run_id": null, "metadata": {} @@ -31,4 +34,4 @@ } }, "operationId": "GetMessage" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 0d0b0d0195b8..938293c4fc60 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" }, "responses": { "200": { @@ -15,6 +15,8 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", + "incomplete_details": null, + "usage": null, "started_at": 1707303197, "expires_at": null, "cancelled_at": null, @@ -24,10 +26,9 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], "metadata": {} } } }, "operationId": "GetRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json index 74cee430ceac..31b0b668a594 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json @@ -3,9 +3,9 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", - "step_id": "step_abc123" + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" }, "responses": { "200": { @@ -38,4 +38,4 @@ } }, "operationId": "GetRunStep" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json index 7f7637e54d59..8d95c82cfe2d 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index e087fd6b1a35..fd90d3e4f9c7 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123" + "threadId": "thread_abc123" }, "responses": { "200": { @@ -58,4 +58,4 @@ } }, "operationId": "ListMessages" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json index 83071db8914c..3bf265748059 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123" + "threadId": "thread_abc123", + "runId": "run_abc123" }, "responses": { "200": { @@ -45,4 +45,4 @@ } }, "operationId": "ListRunSteps" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 864713d3f352..6aae5aba313e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123" + "threadId": "thread_abc123" }, "responses": { "200": { @@ -110,4 +110,4 @@ } }, "operationId": "ListRuns" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index f4c096450604..a53bc2d23bff 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_123", - "run_id": "run_123", + "threadId": "thread_123", + "runId": "run_123", "body": { "tool_outputs": [ { @@ -75,4 +75,4 @@ } }, "operationId": "SubmitToolOutputsToRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json index 3a2fe6a44924..e7610f8ec4cf 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", "body": { "metadata": { "modified": "true", From 6ebf0aac042d7bb20e8e894cb61467024c249637 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 17:48:57 +0200 Subject: [PATCH 20/55] wip --- ...odify_message.json => update_message.json} | 9 ++-- .../2024-05-01-preview/list_messages.json | 8 ++++ ...odify_message.json => update_message.json} | 9 ++-- .../assistants_generated.json | 5 +++ .../examples/update_message.json | 42 +++++++++++++++++++ .../assistants_generated.json | 5 +++ .../examples/list_messages.json | 8 ++++ .../examples/update_message.json | 42 +++++++++++++++++++ 8 files changed, 118 insertions(+), 10 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{modify_message.json => update_message.json} (87%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{modify_message.json => update_message.json} (86%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json similarity index 87% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 2656218af6ad..4b881b8644d9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", - "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", "body": { "metadata": { "key1": "value1", @@ -29,7 +29,6 @@ } } ], - "file_ids": [], "assistant_id": null, "run_id": null, "metadata": { @@ -39,5 +38,5 @@ } } }, - "operationId": "ModifyMessage" -} \ No newline at end of file + "operationId": "UpdateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index fd90d3e4f9c7..4813900797ae 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -27,6 +27,10 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} }, @@ -47,6 +51,10 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json similarity index 86% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index 86e98b3cae31..d7db637b2959 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123 ", + "threadId": "thread_abc123", + "messageId": "msg_abc123 ", "body": { "metadata": { "modified": "true", @@ -31,7 +31,6 @@ } } ], - "file_ids": [], "metadata": { "modified": "true", "user": "abc123" @@ -39,5 +38,5 @@ } } }, - "operationId": "ModifyMessage" -} \ No newline at end of file + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 7180a6ccf25c..3672e58ff075 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -840,6 +840,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json new file mode 100644 index 000000000000..4b881b8644d9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "assistant_id": null, + "run_id": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 71b38202a1e9..29c2298eb6d2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -887,6 +887,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index fd90d3e4f9c7..4813900797ae 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -27,6 +27,10 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} }, @@ -47,6 +51,10 @@ } } ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, "attachments": [], "metadata": {} } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json new file mode 100644 index 000000000000..d7db637b2959 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "messageId": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateMessage" +} From 8384bb5f66ac605d63d0c406c346add8bddbfa2d Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 18:02:58 +0200 Subject: [PATCH 21/55] wip --- .../2024-02-15-preview/update_message.json | 4 ++++ .../2024-05-01-preview/delete_file.json | 18 ++++++++++++++++++ .../examples/2024-05-01-preview/get_run.json | 8 ++++++++ .../2024-05-01-preview/update_message.json | 4 ++++ .../examples/update_message.json | 4 ++++ .../assistants_generated.json | 5 +++++ .../examples/delete_file.json | 18 ++++++++++++++++++ .../2024-05-01-preview/examples/get_run.json | 8 ++++++++ .../examples/update_message.json | 4 ++++ 9 files changed, 73 insertions(+) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 4b881b8644d9..d01dc012fdcd 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -31,6 +31,10 @@ ], "assistant_id": null, "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "complete_at": 1707298421, + "incomplete_at": null, "metadata": { "key1": "value1", "key2": "value2" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 938293c4fc60..2895df4dce16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -22,6 +22,14 @@ "cancelled_at": null, "failed_at": null, "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", "last_error": null, "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index d7db637b2959..eb123f5c8786 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -20,6 +20,10 @@ "created_at": 1699017614, "assistant_id": null, "thread_id": "thread_abc123", + "status": "complete", + "incomplete_details": null, + "complete_at": 1699017614, + "incomplete_at": null, "run_id": null, "role": "user", "content": [ diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index 4b881b8644d9..d01dc012fdcd 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -31,6 +31,10 @@ ], "assistant_id": null, "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "complete_at": 1707298421, + "incomplete_at": null, "metadata": { "key1": "value1", "key2": "value2" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 29c2298eb6d2..f72753e357d4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -501,6 +501,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 938293c4fc60..2895df4dce16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -22,6 +22,14 @@ "cancelled_at": null, "failed_at": null, "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", "last_error": null, "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index d7db637b2959..eb123f5c8786 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -20,6 +20,10 @@ "created_at": 1699017614, "assistant_id": null, "thread_id": "thread_abc123", + "status": "complete", + "incomplete_details": null, + "complete_at": 1699017614, + "incomplete_at": null, "run_id": null, "role": "user", "content": [ From 9e7495f3905f469036117f3d7cc10534f5d67741 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 18:39:50 +0200 Subject: [PATCH 22/55] wip --- .../examples/2024-02-15-preview/create_run.json | 4 +--- .../examples/2024-02-15-preview/update_message.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 4 +--- .../preview/2024-02-15-preview/examples/update_message.json | 2 +- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index b516adecefd2..0221a510b4d2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -4,9 +4,7 @@ "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", - "body": { - "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" - } + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" }, "responses": { "200": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index d01dc012fdcd..0021cd3ec12c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -33,7 +33,7 @@ "run_id": null, "status": "incomplete", "incomplete_details": null, - "complete_at": 1707298421, + "completed_at": 1707298421, "incomplete_at": null, "metadata": { "key1": "value1", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index b516adecefd2..0221a510b4d2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -4,9 +4,7 @@ "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", - "body": { - "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" - } + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index d01dc012fdcd..0021cd3ec12c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -33,7 +33,7 @@ "run_id": null, "status": "incomplete", "incomplete_details": null, - "complete_at": 1707298421, + "completed_at": 1707298421, "incomplete_at": null, "metadata": { "key1": "value1", From aaad749e9f78ed2b55b2774d730e1141f5abed5d Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 18:49:24 +0200 Subject: [PATCH 23/55] removing bodyRoot decorator --- specification/ai/OpenAI.Assistants/runs/routes.tsp | 2 +- .../preview/2024-02-15-preview/assistants_generated.json | 3 +-- .../preview/2024-05-01-preview/assistants_generated.json | 3 +-- .../OpenApiV3/2024-02-15-preview/assistants_generated.yaml | 1 - .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 1 - 5 files changed, 3 insertions(+), 7 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index c65c2d07fa06..8e8c2ed5c5ea 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -30,7 +30,7 @@ namespace Azure.AI.OpenAI.Assistants; @added(ServiceApiVersions.v2024_02_15_preview) op createRun( @path threadId: string, - @bodyRoot createRunOptions: CreateRunOptions, + ...CreateRunOptions, ): ThreadRun; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 3672e58ff075..339b56704b0b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -980,9 +980,8 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index f72753e357d4..bc6e862c9142 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1032,9 +1032,8 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 5d101eb1cb50..780fd223154e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -501,7 +501,6 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index bb72844194ac..ae435ad11ded 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -514,7 +514,6 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. required: true content: application/json: From 1125a13980833a6252458ffcbe6d957d1a07b9a2 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 18:55:33 +0200 Subject: [PATCH 24/55] Checking if things are actually fixed --- .../examples/2024-02-15-preview/create_run.json | 4 +++- .../preview/2024-02-15-preview/examples/create_run.json | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index 0221a510b4d2..b516adecefd2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -4,7 +4,9 @@ "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", - "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index 0221a510b4d2..b516adecefd2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -4,7 +4,9 @@ "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", - "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } }, "responses": { "200": { From 03d2bf5227c11326ac836e29bb3a8647a914ced5 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 19:54:04 +0200 Subject: [PATCH 25/55] Made expandable nullable enum into 'null' instead of null --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_message.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/get_message.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_messages.json | 4 ++-- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../examples/2024-02-15-preview/update_message.json | 2 +- .../examples/2024-05-01-preview/create_message.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 4 ++-- .../examples/2024-05-01-preview/get_message.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_messages.json | 4 ++-- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../examples/2024-05-01-preview/modify_run.json | 4 ++-- .../examples/2024-05-01-preview/retrieve_run.json | 4 ++-- .../examples/2024-05-01-preview/update_message.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_message.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_message.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_messages.json | 4 ++-- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../preview/2024-02-15-preview/examples/update_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 4 ++-- .../preview/2024-05-01-preview/examples/get_message.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_messages.json | 4 ++-- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../preview/2024-05-01-preview/examples/update_message.json | 2 +- 34 files changed, 44 insertions(+), 44 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index c0318a2f3364..aa42b6b47b58 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index 20fd1c2f15c2..dd28adec3245 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index 20f01a6fda3f..efed4e45c9a9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 0021cd3ec12c..42b69df2b38b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index 70ae2b1b9da1..dbf4507564e6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index c67e85fbd7d2..65c0ff9bfa5c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -44,7 +44,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" @@ -52,4 +52,4 @@ } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index d89c0c78aba2..21fe07b60123 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index 4813900797ae..aaff859bd202 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 6aae5aba313e..cfec7464e9c7 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -71,7 +71,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json index ae584dcba811..5c9cb77b68f2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -64,4 +64,4 @@ } }, "operationId": "ModifyRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index 0ec1a07f3837..3bd9941ce8a4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -23,7 +23,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -49,4 +49,4 @@ } }, "operationId": "RetrieveRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index eb123f5c8786..8c73949228c9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -21,7 +21,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": null, + "incomplete_details": "null", "complete_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json index c0318a2f3364..aa42b6b47b58 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json index 20fd1c2f15c2..dd28adec3245 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json index 20f01a6fda3f..efed4e45c9a9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index 0021cd3ec12c..42b69df2b38b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json index 70ae2b1b9da1..dbf4507564e6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index c67e85fbd7d2..65c0ff9bfa5c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -44,7 +44,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" @@ -52,4 +52,4 @@ } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index d89c0c78aba2..21fe07b60123 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index 4813900797ae..aaff859bd202 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 6aae5aba313e..cfec7464e9c7 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -71,7 +71,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index eb123f5c8786..8c73949228c9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -21,7 +21,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": null, + "incomplete_details": "null", "complete_at": 1699017614, "incomplete_at": null, "run_id": null, From a7e5561c3a827752c09215389b00f27cf1aa2740 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 20 Jun 2024 20:07:22 +0200 Subject: [PATCH 26/55] Revert "Made expandable nullable enum into 'null' instead of null" This reverts commit 03d2bf5227c11326ac836e29bb3a8647a914ced5. --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_message.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/get_message.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_messages.json | 4 ++-- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../examples/2024-02-15-preview/update_message.json | 2 +- .../examples/2024-05-01-preview/create_message.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 4 ++-- .../examples/2024-05-01-preview/get_message.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_messages.json | 4 ++-- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../examples/2024-05-01-preview/modify_run.json | 4 ++-- .../examples/2024-05-01-preview/retrieve_run.json | 4 ++-- .../examples/2024-05-01-preview/update_message.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_message.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_message.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_messages.json | 4 ++-- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../preview/2024-02-15-preview/examples/update_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 4 ++-- .../preview/2024-05-01-preview/examples/get_message.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_messages.json | 4 ++-- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../preview/2024-05-01-preview/examples/update_message.json | 2 +- 34 files changed, 44 insertions(+), 44 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index aa42b6b47b58..c0318a2f3364 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index dd28adec3245..20fd1c2f15c2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index efed4e45c9a9..20f01a6fda3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 42b69df2b38b..0021cd3ec12c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index dbf4507564e6..70ae2b1b9da1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 0505342c02f8..28345b1bc1e0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 65c0ff9bfa5c..c67e85fbd7d2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -44,7 +44,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" @@ -52,4 +52,4 @@ } }, "operationId": "CreateThreadAndRun" -} +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index 21fe07b60123..d89c0c78aba2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index aaff859bd202..4813900797ae 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index cfec7464e9c7..6aae5aba313e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -71,7 +71,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json index 5c9cb77b68f2..ae584dcba811 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -64,4 +64,4 @@ } }, "operationId": "ModifyRun" -} +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index 3bd9941ce8a4..0ec1a07f3837 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -23,7 +23,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -49,4 +49,4 @@ } }, "operationId": "RetrieveRun" -} +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index 8c73949228c9..eb123f5c8786 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -21,7 +21,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": "null", + "incomplete_details": null, "complete_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json index aa42b6b47b58..c0318a2f3364 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json index dd28adec3245..20fd1c2f15c2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json index efed4e45c9a9..20f01a6fda3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index 42b69df2b38b..0021cd3ec12c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json index dbf4507564e6..70ae2b1b9da1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 0505342c02f8..28345b1bc1e0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 65c0ff9bfa5c..c67e85fbd7d2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -44,7 +44,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" @@ -52,4 +52,4 @@ } }, "operationId": "CreateThreadAndRun" -} +} \ No newline at end of file diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index 21fe07b60123..d89c0c78aba2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index aaff859bd202..4813900797ae 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index cfec7464e9c7..6aae5aba313e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -71,7 +71,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index 8c73949228c9..eb123f5c8786 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -21,7 +21,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": "null", + "incomplete_details": null, "complete_at": 1699017614, "incomplete_at": null, "run_id": null, From 6fc5b150cb8daa9b412c14143fff1883fd76bd90 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 09:40:47 +0200 Subject: [PATCH 27/55] WIP --- .../create_thread_and_run.json | 5 +- .../{modify_run.json => update_run.json} | 4 +- .../2024-05-01-preview/create_assistant.json | 1 + .../2024-05-01-preview/create_thread.json | 1 + .../2024-05-01-preview/delete_assistant.json | 4 +- .../2024-05-01-preview/get_assistant.json | 4 +- .../2024-05-01-preview/update_assistant.json} | 2 +- .../{modify_run.json => update_run.json} | 4 +- .../assistants_generated.json | 5 ++ .../examples/create_thread_and_run.json | 5 +- .../examples/modify_assistant.json | 31 --------- .../examples/update_run.json | 42 ++++++++++++ .../assistants_generated.json | 7 +- .../examples/create_assistant.json | 1 + .../examples/create_thread.json | 1 + .../examples/delete_assistant.json | 4 +- .../examples/get_assistant.json | 4 +- .../examples/update_assistant.json} | 2 +- .../examples/update_run.json | 67 +++++++++++++++++++ 19 files changed, 144 insertions(+), 50 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/{modify_run.json => update_run.json} (97%) rename specification/ai/{data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json => OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json} (97%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{modify_run.json => update_run.json} (98%) delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json rename specification/ai/{OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json => data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json} (97%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index 564a64e920e6..2babffbce6d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -25,10 +25,11 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "usage": null, + "incomplete_details": null, "metadata": {} } } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json similarity index 97% rename from specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json rename to specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index 9888b7b5ceff..34add54579c9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -38,5 +38,5 @@ } } }, - "operationId": "ModifyRun" -} \ No newline at end of file + "operationId": "UpdateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 69f66a84e09d..66b92133fe32 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -29,6 +29,7 @@ "type": "code_interpreter" } ], + "tool_resources": {}, "metadata": {}, "top_p": 1.0, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json index 25dc7e42c5e2..101ade5b001f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -11,6 +11,7 @@ "id": "thread_v7V4csrNOxtNmgcwGg496Smx", "object": "thread", "created_at": 1707297136, + "tool_resources": {}, "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json index c6e1241e3828..a4675ff13925 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json index b45c802b706e..514a7c390012 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_abc123" + "assistantId": "asst_abc123" }, "responses": { "200": { @@ -22,7 +22,7 @@ ], "top_p": 1.0, "temperature": 1.0, - "file_ids": [], + "tool_resources": {}, "metadata": {}, "response_format": "auto" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json similarity index 97% rename from specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json index d04bb4d5989f..c0e7fc6ee699 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_abc123", + "assistantId": "asst_abc123", "body": { "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": [ diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json similarity index 98% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index ae584dcba811..b2a843363dd3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -63,5 +63,5 @@ } } }, - "operationId": "ModifyRun" -} \ No newline at end of file + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 339b56704b0b..cb413bb92e10 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -1081,6 +1081,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index 564a64e920e6..2babffbce6d5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -25,10 +25,11 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "usage": null, + "incomplete_details": null, "metadata": {} } } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json deleted file mode 100644 index 5fbe6b043ad1..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/modify_assistant.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "title": "Modifies an assistant.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "assistant_id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", - "body": { - "name": "Math Tutor Improved" - } - }, - "responses": { - "200": { - "body": { - "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", - "object": "assistant", - "created_at": 1718875084, - "name": "Math Tutor Improved", - "description": null, - "model": "gpt-4-1106-preview", - "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", - "tools": [ - { - "type": "code_interpreter" - } - ], - "metadata": {} - } - } - }, - "operationId": "UpdateAssistant" -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json new file mode 100644 index 000000000000..34add54579c9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -0,0 +1,42 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index bc6e862c9142..ce7d6dbd54ef 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -253,7 +253,7 @@ }, "x-ms-examples": { "Modifies an assistant.": { - "$ref": "./examples/modify_assistant.json" + "$ref": "./examples/update_assistant.json" } } }, @@ -1133,6 +1133,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json index 69f66a84e09d..66b92133fe32 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -29,6 +29,7 @@ "type": "code_interpreter" } ], + "tool_resources": {}, "metadata": {}, "top_p": 1.0, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json index 25dc7e42c5e2..101ade5b001f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json @@ -11,6 +11,7 @@ "id": "thread_v7V4csrNOxtNmgcwGg496Smx", "object": "thread", "created_at": 1707297136, + "tool_resources": {}, "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json index c6e1241e3828..a4675ff13925 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteAssistant" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json index b45c802b706e..514a7c390012 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_abc123" + "assistantId": "asst_abc123" }, "responses": { "200": { @@ -22,7 +22,7 @@ ], "top_p": 1.0, "temperature": 1.0, - "file_ids": [], + "tool_resources": {}, "metadata": {}, "response_format": "auto" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json similarity index 97% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json rename to specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json index d04bb4d5989f..c0e7fc6ee699 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "assistant_id": "asst_abc123", + "assistantId": "asst_abc123", "body": { "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": [ diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json new file mode 100644 index 000000000000..b2a843363dd3 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -0,0 +1,67 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "UpdateRun" +} From e437a1a2bbd11866d9b044a0a4de6496c0e635cb Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 10:05:54 +0200 Subject: [PATCH 28/55] wip --- .../2024-02-15-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-02-15-preview/update_run.json | 7 ++++--- .../examples/2024-05-01-preview/update_run.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-02-15-preview/examples/update_run.json | 7 ++++--- .../preview/2024-05-01-preview/examples/update_run.json | 4 ++-- 6 files changed, 14 insertions(+), 12 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index b6cf1b3a88b6..ff1009e9c1fc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -31,6 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", + "incomplete_details": null, "tools": [ { "type": "function", @@ -59,7 +60,6 @@ } } ], - "file_ids": [], "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index 34add54579c9..15e95dd58e30 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", "body": { "metadata": { "key1": "value1", @@ -30,7 +30,8 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "incomplete_details": null, + "usage": null, "metadata": { "key1": "value1", "key2": "value2" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index b2a843363dd3..ead6a5db2cd0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123", + "threadId": "thread_abc123", + "runId": "run_abc123", "body": { "metadata": { "user_id": "user_abc123" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index b6cf1b3a88b6..ff1009e9c1fc 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -31,6 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", + "incomplete_details": null, "tools": [ { "type": "function", @@ -59,7 +60,6 @@ } } ], - "file_ids": [], "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json index 34add54579c9..15e95dd58e30 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-02-15-preview", - "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", - "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", "body": { "metadata": { "key1": "value1", @@ -30,7 +30,8 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "file_ids": [], + "incomplete_details": null, + "usage": null, "metadata": { "key1": "value1", "key2": "value2" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index b2a843363dd3..ead6a5db2cd0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123", + "threadId": "thread_abc123", + "runId": "run_abc123", "body": { "metadata": { "user_id": "user_abc123" From cd408bb29a6d0ef84e5ead24c1859d0b958f1d9c Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 10:23:33 +0200 Subject: [PATCH 29/55] Possible solution to bad @body usage --- .../ai/OpenAI.Assistants/messages/routes.tsp | 6 ++--- .../assistants_generated.json | 26 ------------------- .../assistants_generated.json | 3 +-- .../assistants_generated.yaml | 17 ------------ .../assistants_generated.yaml | 1 - 5 files changed, 3 insertions(+), 50 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 9d8b27ad11f1..4c873f5bc603 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -27,14 +27,12 @@ namespace Azure.AI.OpenAI.Assistants; #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" @post @route("/threads/{threadId}/messages") -@added(ServiceApiVersions.v2024_02_15_preview) +@added(ServiceApiVersions.v2024_05_01_preview) op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - @added(ServiceApiVersions.v2024_05_01_preview) - @body - threadMessageOptions: ThreadMessageOptions, + ...ThreadMessageOptions, ): ThreadMessage; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index cb413bb92e10..f034e6569ae9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -734,32 +734,6 @@ "$ref": "./examples/list_messages.json" } } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - }, - "x-ms-examples": { - "Create a message.": { - "$ref": "./examples/create_message.json" - } - } } }, "/threads/{threadId}/messages/{messageId}": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index ce7d6dbd54ef..ef9daa658d2f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -790,9 +790,8 @@ "type": "string" }, { - "name": "threadMessageOptions", + "name": "body", "in": "body", - "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 780fd223154e..614432a23c30 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -334,23 +334,6 @@ paths: schema: $ref: '#/components/schemas/ThreadDeletionStatus' /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' get: operationId: listMessages description: Gets a list of messages that exist on a thread. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index ae435ad11ded..af6a51eac31c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -352,7 +352,6 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: - description: A single message within an assistant thread, as provided during that thread's creation for its initial state. required: true content: application/json: From ff1acc25465ecb4618863e6fe9db33bf337ac989 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 13:11:07 +0200 Subject: [PATCH 30/55] Found better solution for version added mismatch createMessage --- .../ai/OpenAI.Assistants/messages/models.tsp | 3 +- .../ai/OpenAI.Assistants/messages/routes.tsp | 2 +- .../assistants_generated.json | 60 +++++++++++++++++++ .../assistants_generated.yaml | 49 +++++++++++++++ 4 files changed, 112 insertions(+), 2 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp index 118cdf5a0d73..3f59eaed0f3c 100644 --- a/specification/ai/OpenAI.Assistants/messages/models.tsp +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -8,7 +8,7 @@ namespace Azure.AI.OpenAI.Assistants; using TypeSpec.Versioning; /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ -@added(ServiceApiVersions.v2024_05_01_preview) +@added(ServiceApiVersions.v2024_02_15_preview) model ThreadMessageOptions { /** * The role of the entity that is creating the message. Allowed values include: @@ -25,6 +25,7 @@ model ThreadMessageOptions { /** A list of files attached to the message, and the tools they should be added to. */ #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) attachments?: MessageAttachment[] | null; ...OptionalNullableMetadata; diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 4c873f5bc603..4021a83ce71f 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -27,7 +27,7 @@ namespace Azure.AI.OpenAI.Assistants; #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" @post @route("/threads/{threadId}/messages") -@added(ServiceApiVersions.v2024_05_01_preview) +@added(ServiceApiVersions.v2024_02_15_preview) op createMessage( @path threadId: string, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index f034e6569ae9..e9c7a86cb4eb 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -734,6 +734,40 @@ "$ref": "./examples/list_messages.json" } } + }, + "post": { + "operationId": "CreateMessage", + "description": "Creates a new message on a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to create the new message on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThreadMessageOptions" + } + } + ], + "responses": { + "200": { + "description": "A representation of the new message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } + } } }, "/threads/{threadId}/messages/{messageId}": { @@ -3045,6 +3079,32 @@ "metadata" ] }, + "ThreadMessageOptions": { + "type": "object", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into\nthe conversation." + }, + "content": { + "type": "string", + "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\na separate call to the create message API." + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + }, "ThreadRun": { "type": "object", "description": "Data representing a single evaluation run of an assistant thread.", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 614432a23c30..a8d62eba2e66 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -334,6 +334,29 @@ paths: schema: $ref: '#/components/schemas/ThreadDeletionStatus' /threads/{threadId}/messages: + post: + operationId: createMessage + description: Creates a new message on a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to create the new message on. + schema: + type: string + responses: + '200': + description: A representation of the new message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessageOptions' get: operationId: listMessages description: Gets a list of messages that exist on a thread. @@ -2492,6 +2515,32 @@ components: nullable: true description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. description: A single, existing message within an assistant thread. + ThreadMessageOptions: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: |- + The role of the entity that is creating the message. Allowed values include: + - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. + - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into + the conversation. + content: + type: string + description: |- + The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via + a separate call to the create message API. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. ThreadRun: type: object required: From 9c6fede6223c7800e477e8a62a535f0403f848fd Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 13:26:09 +0200 Subject: [PATCH 31/55] wip --- .../examples/2024-05-01-preview/get_message.json | 1 + .../examples/2024-05-01-preview/update_message.json | 6 ++++-- .../preview/2024-05-01-preview/examples/get_message.json | 1 + .../preview/2024-05-01-preview/examples/update_message.json | 6 ++++-- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index d89c0c78aba2..03af4b1a4ebe 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -29,6 +29,7 @@ "completed_at": 1707298439, "assistant_id": null, "run_id": null, + "attachments": [], "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index eb123f5c8786..3c48a77d5a18 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -8,7 +8,8 @@ "body": { "metadata": { "modified": "true", - "user": "abc123" + "user": "abc123", + "attachments": [] } } }, @@ -22,7 +23,7 @@ "thread_id": "thread_abc123", "status": "complete", "incomplete_details": null, - "complete_at": 1699017614, + "completed_at": 1699017614, "incomplete_at": null, "run_id": null, "role": "user", @@ -35,6 +36,7 @@ } } ], + "attachments": [], "metadata": { "modified": "true", "user": "abc123" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index d89c0c78aba2..03af4b1a4ebe 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -29,6 +29,7 @@ "completed_at": 1707298439, "assistant_id": null, "run_id": null, + "attachments": [], "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index eb123f5c8786..3c48a77d5a18 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -8,7 +8,8 @@ "body": { "metadata": { "modified": "true", - "user": "abc123" + "user": "abc123", + "attachments": [] } } }, @@ -22,7 +23,7 @@ "thread_id": "thread_abc123", "status": "complete", "incomplete_details": null, - "complete_at": 1699017614, + "completed_at": 1699017614, "incomplete_at": null, "run_id": null, "role": "user", @@ -35,6 +36,7 @@ } } ], + "attachments": [], "metadata": { "modified": "true", "user": "abc123" From 73f2949910e4198fff4db755ff6a66339df5557a Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 13:44:03 +0200 Subject: [PATCH 32/55] WIP --- .../examples/2024-05-01-preview/cancel_run.json | 13 +++++++------ .../examples/2024-05-01-preview/list_runs.json | 16 ---------------- .../examples/2024-05-01-preview/update_run.json | 8 -------- .../2024-05-01-preview/examples/cancel_run.json | 13 +++++++------ .../2024-05-01-preview/examples/list_runs.json | 16 ---------------- .../2024-05-01-preview/examples/update_run.json | 8 -------- 6 files changed, 14 insertions(+), 60 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index 730bb59c4e1c..7f3456272098 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -28,13 +28,14 @@ "type": "file_search" } ], - "tool_resources": { - "file_search": { - "vector_store_ids": [ - "vs_123" - ] - } + "tool_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 6aae5aba313e..7db1209e3ac3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -31,14 +31,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": {}, "usage": { "prompt_tokens": 123, @@ -77,14 +69,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": {}, "usage": { "prompt_tokens": 123, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index ead6a5db2cd0..678897d270a5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -34,14 +34,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": { "user_id": "user_abc123" }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index 730bb59c4e1c..7f3456272098 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -28,13 +28,14 @@ "type": "file_search" } ], - "tool_resources": { - "file_search": { - "vector_store_ids": [ - "vs_123" - ] - } + "tool_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 6aae5aba313e..7db1209e3ac3 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -31,14 +31,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": {}, "usage": { "prompt_tokens": 123, @@ -77,14 +69,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": {}, "usage": { "prompt_tokens": 123, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index ead6a5db2cd0..678897d270a5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -34,14 +34,6 @@ "type": "code_interpreter" } ], - "tool_resources": { - "code_interpreter": { - "file_ids": [ - "file-abc123", - "file-abc456" - ] - } - }, "metadata": { "user_id": "user_abc123" }, From 564439f54fcebca4bf9a89715ea047da0f75d98c Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 14:17:51 +0200 Subject: [PATCH 33/55] Started with vector store stuff --- .../create_thread_and_run.json | 3 +- .../create_vector_store.json | 15 ++++++---- .../2024-05-01-preview/get_run_step.json | 3 +- ...ector_store.json => get_vector_store.json} | 4 +-- ...e_file.json => get_vector_store_file.json} | 8 +++--- ....json => get_vector_store_file_batch.json} | 4 +-- .../2024-05-01-preview/list_run_steps.json | 3 +- .../list_vector_stores.json | 16 +++++++---- .../submit_tool_outputs_to_run.json | 1 + ...or_store.json => update_vector_store.json} | 6 ++-- .../assistants_generated.json | 20 +++++++++---- .../examples/create_thread_and_run.json | 3 +- .../examples/create_vector_store.json | 15 ++++++---- .../examples/get_run_step.json | 3 +- .../examples/get_vector_store.json | 18 ++++++++++++ .../examples/get_vector_store_file.json | 22 +++++++++++++++ .../examples/get_vector_store_file_batch.json | 28 +++++++++++++++++++ .../examples/list_run_steps.json | 3 +- .../examples/list_vector_stores.json | 16 +++++++---- .../examples/submit_tool_outputs_to_run.json | 1 + 20 files changed, 146 insertions(+), 46 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{retrieve_vector_store.json => get_vector_store.json} (89%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{retrieve_vector_store_file.json => get_vector_store_file.json} (78%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{retrieve_vector_store_file_batch.json => get_vector_store_file_batch.json} (92%) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{modify_vector_store.json => update_vector_store.json} (88%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index c67e85fbd7d2..5fdbcedb411f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -34,7 +34,6 @@ "model": "gpt-4-turbo", "instructions": "You are a helpful assistant.", "tools": [], - "tool_resources": {}, "metadata": {}, "temperature": 1.0, "top_p": 1.0, @@ -52,4 +51,4 @@ } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json index 463f69000d18..60ae754b38c9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json @@ -2,10 +2,10 @@ "title": "Creates a vector store.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview" - }, - "body": { - "name": "Support FAQ" + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } }, "responses": { "200": { @@ -14,7 +14,10 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, "file_counts": { "in_progress": 0, "completed": 3, @@ -26,4 +29,4 @@ } }, "operationId": "CreateVectorStore" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json index 31b0b668a594..556262ddc1a4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -33,7 +33,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json similarity index 89% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json index f900cd7c2016..b9d65fae133b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json @@ -14,5 +14,5 @@ } } }, - "operationId": "RetrieveVectorStore" -} \ No newline at end of file + "operationId": "GetVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json similarity index 78% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json index b170465f678f..8b7e637e7492 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "file_id": "file-abc123" + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" }, "responses": { "200": { @@ -18,5 +18,5 @@ } } }, - "operationId": "RetrieveVectorStoreFile" -} \ No newline at end of file + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json similarity index 92% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json index 0dd6c8938111..1e54af39f47c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json @@ -24,5 +24,5 @@ } } }, - "operationId": "RetrieveVectorStoreFileBatch" -} \ No newline at end of file + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json index 3bf265748059..e57f889c9165 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -35,7 +35,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } ], "first_id": "step_abc123", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json index 34ace65ede87..df84331efbac 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json @@ -14,28 +14,34 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "in_progress", "file_counts": { "in_progress": 0, "completed": 3, "failed": 0, "cancelled": 0, "total": 3 - } + }, + "last_active_at": 1699061776, + "metadata": {} }, { "id": "vs_abc456", "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ v2", - "bytes": 139920, + "usage_bytes": 139920, + "status": "in_progress", "file_counts": { "in_progress": 0, "completed": 3, "failed": 0, "cancelled": 0, "total": 3 - } + }, + "last_active_at": 1699061776, + "metadata": {} } ], "first_id": "vs_abc123", @@ -45,4 +51,4 @@ } }, "operationId": "ListVectorStores" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index a53bc2d23bff..544186d8d8ac 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -63,6 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json similarity index 88% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json index e410a04e82a9..560bba7fe034 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "name": "Support FAQ" } @@ -26,5 +26,5 @@ } } }, - "operationId": "ModifyVectorStore" -} \ No newline at end of file + "operationId": "UpdateVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index ef9daa658d2f..3d864bda9183 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1597,6 +1597,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Retrieves a vector store.": { + "$ref": "./examples/get_vector_store.json" + } } }, "post": { @@ -1626,11 +1631,6 @@ "$ref": "#/definitions/VectorStore" } } - }, - "x-ms-examples": { - "Modifies a vector store.": { - "$ref": "./examples/modify_vector_store.json" - } } }, "delete": { @@ -1738,6 +1738,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Retrieves a vector store file batch.": { + "$ref": "./examples/get_vector_store_file_batch.json" + } } } }, @@ -2169,6 +2174,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Retrieves a vector store file.": { + "$ref": "./examples/get_vector_store_file.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index c67e85fbd7d2..5fdbcedb411f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -34,7 +34,6 @@ "model": "gpt-4-turbo", "instructions": "You are a helpful assistant.", "tools": [], - "tool_resources": {}, "metadata": {}, "temperature": 1.0, "top_p": 1.0, @@ -52,4 +51,4 @@ } }, "operationId": "CreateThreadAndRun" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json index 463f69000d18..60ae754b38c9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json @@ -2,10 +2,10 @@ "title": "Creates a vector store.", "parameters": { "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview" - }, - "body": { - "name": "Support FAQ" + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } }, "responses": { "200": { @@ -14,7 +14,10 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, "file_counts": { "in_progress": 0, "completed": 3, @@ -26,4 +29,4 @@ } }, "operationId": "CreateVectorStore" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json index 31b0b668a594..556262ddc1a4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json @@ -33,7 +33,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json new file mode 100644 index 000000000000..b9d65fae133b --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776 + } + } + }, + "operationId": "GetVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json new file mode 100644 index 000000000000..8b7e637e7492 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json @@ -0,0 +1,22 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json new file mode 100644 index 000000000000..1e54af39f47c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + }, + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json index 3bf265748059..e57f889c9165 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json @@ -35,7 +35,8 @@ "prompt_tokens": 123, "completion_tokens": 456, "total_tokens": 579 - } + }, + "metadata": {} } ], "first_id": "step_abc123", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json index 34ace65ede87..df84331efbac 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json @@ -14,28 +14,34 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "in_progress", "file_counts": { "in_progress": 0, "completed": 3, "failed": 0, "cancelled": 0, "total": 3 - } + }, + "last_active_at": 1699061776, + "metadata": {} }, { "id": "vs_abc456", "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ v2", - "bytes": 139920, + "usage_bytes": 139920, + "status": "in_progress", "file_counts": { "in_progress": 0, "completed": 3, "failed": 0, "cancelled": 0, "total": 3 - } + }, + "last_active_at": 1699061776, + "metadata": {} } ], "first_id": "vs_abc123", @@ -45,4 +51,4 @@ } }, "operationId": "ListVectorStores" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index a53bc2d23bff..544186d8d8ac 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -63,6 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { From 91eb6f7e1e249749160e5598eb34bcfba59bba0f Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 14:55:18 +0200 Subject: [PATCH 34/55] More fixes for vector store stuff --- .../create_vector_store_file.json | 4 +-- .../create_vector_store_file_batch.json | 28 ++++++++++--------- .../delete_vector_store.json | 4 +-- .../delete_vector_store_file.json | 6 ++-- .../2024-05-01-preview/get_vector_store.json | 16 +++++++++-- .../list_vector_store_file_batch.json | 6 ++-- .../list_vector_store_files.json | 4 +-- ...or_store.json => modify_vector_store.json} | 7 +++-- .../assistants_generated.json | 5 ++++ .../examples/create_vector_store_file.json | 4 +-- .../create_vector_store_file_batch.json | 28 ++++++++++--------- .../examples/delete_vector_store.json | 4 +-- .../examples/delete_vector_store_file.json | 6 ++-- .../examples/get_vector_store.json | 16 +++++++++-- .../examples/list_vector_store_files.json | 4 +-- .../examples/modify_vector_store.json | 9 ++++-- 16 files changed, 95 insertions(+), 56 deletions(-) rename specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/{update_vector_store.json => modify_vector_store.json} (77%) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json index d70d6788c5f6..404fe3f1caf9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "file_id": "file-abc123" } @@ -22,4 +22,4 @@ } }, "operationId": "CreateVectorStoreFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json index 42e85d14c474..2f4df0d7390d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "file_ids": [ "file-abc123", @@ -13,19 +13,21 @@ }, "responses": { "200": { - "id": "vsfb_abc123", - "object": "vector_store.file_batch", - "created_at": 1699061776, - "vector_store_id": "vs_abc123", - "status": "in_progress", - "file_counts": { - "in_progress": 1, - "completed": 1, - "failed": 0, - "cancelled": 0, - "total": 0 + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } } } }, "operationId": "CreateVectorStoreFileBatch" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json index a4ab908cc51b..1adda1765fb3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123 " + "vectorStoreId": "vs_abc123 " }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteVectorStore" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json index 4c0f2edeab29..804790877bdb 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "file_id": "file_abc123" + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" }, "responses": { "200": { @@ -16,4 +16,4 @@ } }, "operationId": "DeleteVectorStoreFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json index b9d65fae133b..a8cc51d89802 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json @@ -3,14 +3,26 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123" + "vectorStoreId": "vs_abc123" }, "responses": { "200": { "body": { "id": "vs_abc123", "object": "vector_store", - "created_at": 1699061776 + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } } } }, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json index de31c186d977..1319d24cd442 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "batch_id": "vsfb_abc123" + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" }, "responses": { "200": { @@ -31,4 +31,4 @@ } }, "operationId": "ListVectorStoreFileBatch" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json index 1dc2091e1178..c9766f6a71a4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123" + "vectorStoreId": "vs_abc123" }, "responses": { "200": { @@ -30,4 +30,4 @@ } }, "operationId": "ListVectorStoreFiles" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json similarity index 77% rename from specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json rename to specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json index 560bba7fe034..935bdadbd7d2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_vector_store.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json @@ -15,7 +15,10 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, "file_counts": { "in_progress": 0, "completed": 3, @@ -26,5 +29,5 @@ } } }, - "operationId": "UpdateVectorStore" + "operationId": "ModifyVectorStore" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 3d864bda9183..ac5d13f90dc7 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1631,6 +1631,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Modifies a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } } }, "delete": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json index d70d6788c5f6..404fe3f1caf9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "file_id": "file-abc123" } @@ -22,4 +22,4 @@ } }, "operationId": "CreateVectorStoreFile" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json index 42e85d14c474..2f4df0d7390d 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "file_ids": [ "file-abc123", @@ -13,19 +13,21 @@ }, "responses": { "200": { - "id": "vsfb_abc123", - "object": "vector_store.file_batch", - "created_at": 1699061776, - "vector_store_id": "vs_abc123", - "status": "in_progress", - "file_counts": { - "in_progress": 1, - "completed": 1, - "failed": 0, - "cancelled": 0, - "total": 0 + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } } } }, "operationId": "CreateVectorStoreFileBatch" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json index a4ab908cc51b..1adda1765fb3 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123 " + "vectorStoreId": "vs_abc123 " }, "responses": { "200": { @@ -15,4 +15,4 @@ } }, "operationId": "DeleteVectorStore" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json index 4c0f2edeab29..804790877bdb 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "file_id": "file_abc123" + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" }, "responses": { "200": { @@ -16,4 +16,4 @@ } }, "operationId": "DeleteVectorStoreFile" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json index b9d65fae133b..a8cc51d89802 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json @@ -3,14 +3,26 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123" + "vectorStoreId": "vs_abc123" }, "responses": { "200": { "body": { "id": "vs_abc123", "object": "vector_store", - "created_at": 1699061776 + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json index 1dc2091e1178..c9766f6a71a4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123" + "vectorStoreId": "vs_abc123" }, "responses": { "200": { @@ -30,4 +30,4 @@ } }, "operationId": "ListVectorStoreFiles" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json index e410a04e82a9..935bdadbd7d2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json @@ -3,7 +3,7 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", + "vectorStoreId": "vs_abc123", "body": { "name": "Support FAQ" } @@ -15,7 +15,10 @@ "object": "vector_store", "created_at": 1699061776, "name": "Support FAQ", - "bytes": 139920, + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, "file_counts": { "in_progress": 0, "completed": 3, @@ -27,4 +30,4 @@ } }, "operationId": "ModifyVectorStore" -} \ No newline at end of file +} From ab6d862e7d0404f71ee1682a7b95cae0e93fb54f Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 15:07:19 +0200 Subject: [PATCH 35/55] More fixes --- .../2024-05-01-preview/cancel_vector_store_file_batch.json | 4 ++-- .../2024-05-01-preview/create_vector_store_file_batch.json | 2 +- .../2024-05-01-preview/get_vector_store_file_batch.json | 2 +- .../2024-05-01-preview/list_vector_store_files.json | 6 ++++++ .../examples/cancel_vector_store_file_batch.json | 4 ++-- .../examples/create_vector_store_file_batch.json | 2 +- .../examples/get_vector_store_file_batch.json | 2 +- .../examples/list_vector_store_files.json | 6 ++++++ 8 files changed, 20 insertions(+), 8 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json index 3d492a3bea29..4f60bccba41a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -10,7 +10,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "cancelling", @@ -25,4 +25,4 @@ } }, "operationId": "CancelVectorStoreFileBatch" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json index 2f4df0d7390d..c985b6e7a580 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -15,7 +15,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "in_progress", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json index 1e54af39f47c..e6573cd6dc6a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json @@ -10,7 +10,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "in_progress", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json index c9766f6a71a4..e6406462f735 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -12,12 +12,18 @@ "data": [ { "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, "object": "vector_store.file", "created_at": 1699061776, "vector_store_id": "vs_abc123" }, { "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, "object": "vector_store.file", "created_at": 1699061776, "vector_store_id": "vs_abc123" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json index 3d492a3bea29..4f60bccba41a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json @@ -10,7 +10,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "cancelling", @@ -25,4 +25,4 @@ } }, "operationId": "CancelVectorStoreFileBatch" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json index 2f4df0d7390d..c985b6e7a580 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json @@ -15,7 +15,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "in_progress", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json index 1e54af39f47c..e6573cd6dc6a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json @@ -10,7 +10,7 @@ "200": { "body": { "id": "vsfb_abc123", - "object": "vector_store.file_batch", + "object": "vector_store.files_batch", "created_at": 1699061776, "vector_store_id": "vs_abc123", "status": "in_progress", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json index c9766f6a71a4..e6406462f735 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json @@ -12,12 +12,18 @@ "data": [ { "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, "object": "vector_store.file", "created_at": 1699061776, "vector_store_id": "vs_abc123" }, { "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, "object": "vector_store.file", "created_at": 1699061776, "vector_store_id": "vs_abc123" From e475d00c462a3b46c954da928bd7159a29de3fef Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 15:28:20 +0200 Subject: [PATCH 36/55] Last fixes for vector store batch files --- .../cancel_vector_store_file_batch.json | 4 +- .../get_vector_store_file.json | 1 + .../get_vector_store_file_batch.json | 4 +- .../list_vector_store_file_batch_files.json | 40 +++++++++++++++++++ .../assistants_generated.json | 3 ++ .../cancel_vector_store_file_batch.json | 4 +- .../examples/get_vector_store_file.json | 1 + .../examples/get_vector_store_file_batch.json | 4 +- .../list_vector_store_file_batch_files.json | 40 +++++++++++++++++++ 9 files changed, 93 insertions(+), 8 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json index 4f60bccba41a..1d73787e8c47 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "batch_id": "vsfb_abc123" + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" }, "responses": { "200": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json index 8b7e637e7492..2f351de142b6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json @@ -12,6 +12,7 @@ "id": "file-abc123", "object": "vector_store.file", "created_at": 1699061776, + "usage_bytes": 123456, "vector_store_id": "vs_abcd", "status": "completed", "last_error": null diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json index e6573cd6dc6a..18f0a0f0a385 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "batch_id": "vsfb_abc123" + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" }, "responses": { "200": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..9773921e3b69 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index ac5d13f90dc7..6575df2fad3c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -2102,6 +2102,9 @@ } }, "x-ms-examples": { + "Returns a list of vector store files of a given batch.": { + "$ref": "./examples/list_vector_store_file_batch_files.json" + }, "Returns a list of vector store files.": { "$ref": "./examples/list_vector_store_files.json" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json index 4f60bccba41a..1d73787e8c47 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "batch_id": "vsfb_abc123" + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json index 8b7e637e7492..2f351de142b6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json @@ -12,6 +12,7 @@ "id": "file-abc123", "object": "vector_store.file", "created_at": 1699061776, + "usage_bytes": 123456, "vector_store_id": "vs_abcd", "status": "completed", "last_error": null diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json index e6573cd6dc6a..18f0a0f0a385 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json @@ -3,8 +3,8 @@ "parameters": { "endpoint": "{endpoint}", "api-version": "2024-05-01-preview", - "vector_store_id": "vs_abc123", - "batch_id": "vsfb_abc123" + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" }, "responses": { "200": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..9773921e3b69 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} From 39fdbc665924b28a0f55dc15c4db8f101e4c5a38 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 15:35:18 +0200 Subject: [PATCH 37/55] Using string 'null' instread of JSON null --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_message.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-02-15-preview/get_message.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_messages.json | 4 ++-- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../2024-02-15-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-02-15-preview/update_message.json | 2 +- .../examples/2024-02-15-preview/update_run.json | 2 +- .../examples/2024-05-01-preview/cancel_run.json | 2 +- .../examples/2024-05-01-preview/create_message.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/get_message.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_messages.json | 4 ++-- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../examples/2024-05-01-preview/retrieve_run.json | 4 ++-- .../2024-05-01-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-05-01-preview/update_message.json | 2 +- .../examples/2024-05-01-preview/update_run.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_message.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_message.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_messages.json | 4 ++-- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-02-15-preview/examples/update_message.json | 2 +- .../preview/2024-02-15-preview/examples/update_run.json | 2 +- .../preview/2024-05-01-preview/examples/cancel_run.json | 2 +- .../preview/2024-05-01-preview/examples/create_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-05-01-preview/examples/get_message.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_messages.json | 4 ++-- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-05-01-preview/examples/update_message.json | 2 +- .../preview/2024-05-01-preview/examples/update_run.json | 2 +- 45 files changed, 52 insertions(+), 52 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index c0318a2f3364..aa42b6b47b58 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index 20fd1c2f15c2..dd28adec3245 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index 20f01a6fda3f..efed4e45c9a9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index ff1009e9c1fc..e26581f15b41 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "function", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 0021cd3ec12c..42b69df2b38b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index 15e95dd58e30..ef2a9ff15415 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index 7f3456272098..c9191a6dec25 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index 70ae2b1b9da1..dbf4507564e6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index 03af4b1a4ebe..eabd6abfbc81 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index 4813900797ae..aaff859bd202 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 7db1209e3ac3..0b27b3e61c16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index 0ec1a07f3837..3bd9941ce8a4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -23,7 +23,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -49,4 +49,4 @@ } }, "operationId": "RetrieveRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index 544186d8d8ac..29de7d1ef280 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": null, + "incomplete_details": "null", "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index 3c48a77d5a18..f516aa44f1cc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -22,7 +22,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index 678897d270a5..87b98371bb89 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json index c0318a2f3364..aa42b6b47b58 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json index 20fd1c2f15c2..dd28adec3245 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json index 20f01a6fda3f..efed4e45c9a9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index ff1009e9c1fc..e26581f15b41 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "function", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index 0021cd3ec12c..42b69df2b38b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json index 15e95dd58e30..ef2a9ff15415 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index 7f3456272098..c9191a6dec25 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json index 70ae2b1b9da1..dbf4507564e6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index 03af4b1a4ebe..eabd6abfbc81 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index 4813900797ae..aaff859bd202 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 7db1209e3ac3..0b27b3e61c16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index 544186d8d8ac..29de7d1ef280 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": null, + "incomplete_details": "null", "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index 3c48a77d5a18..f516aa44f1cc 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -22,7 +22,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": null, + "incomplete_details": "null", "completed_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index 678897d270a5..87b98371bb89 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" From 841565a1d9ad873ab56fedfc903aa7656b45beb1 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 15:44:09 +0200 Subject: [PATCH 38/55] Revert "Using string 'null' instread of JSON null" This reverts commit 39fdbc665924b28a0f55dc15c4db8f101e4c5a38. --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_message.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-02-15-preview/get_message.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_messages.json | 4 ++-- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../2024-02-15-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-02-15-preview/update_message.json | 2 +- .../examples/2024-02-15-preview/update_run.json | 2 +- .../examples/2024-05-01-preview/cancel_run.json | 2 +- .../examples/2024-05-01-preview/create_message.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/get_message.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_messages.json | 4 ++-- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../examples/2024-05-01-preview/retrieve_run.json | 4 ++-- .../2024-05-01-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-05-01-preview/update_message.json | 2 +- .../examples/2024-05-01-preview/update_run.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_message.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_message.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_messages.json | 4 ++-- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-02-15-preview/examples/update_message.json | 2 +- .../preview/2024-02-15-preview/examples/update_run.json | 2 +- .../preview/2024-05-01-preview/examples/cancel_run.json | 2 +- .../preview/2024-05-01-preview/examples/create_message.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-05-01-preview/examples/get_message.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_messages.json | 4 ++-- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-05-01-preview/examples/update_message.json | 2 +- .../preview/2024-05-01-preview/examples/update_run.json | 2 +- 45 files changed, 52 insertions(+), 52 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json index aa42b6b47b58..c0318a2f3364 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json index dd28adec3245..20fd1c2f15c2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json index efed4e45c9a9..20f01a6fda3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index e26581f15b41..ff1009e9c1fc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "function", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json index 42b69df2b38b..0021cd3ec12c 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index ef2a9ff15415..15e95dd58e30 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index c9191a6dec25..7f3456272098 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json index dbf4507564e6..70ae2b1b9da1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 0505342c02f8..28345b1bc1e0 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json index eabd6abfbc81..03af4b1a4ebe 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json index aaff859bd202..4813900797ae 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 0b27b3e61c16..7db1209e3ac3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index 3bd9941ce8a4..0ec1a07f3837 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -23,7 +23,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -49,4 +49,4 @@ } }, "operationId": "RetrieveRun" -} +} \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index 29de7d1ef280..544186d8d8ac 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": "null", + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index f516aa44f1cc..3c48a77d5a18 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -22,7 +22,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index 87b98371bb89..678897d270a5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json index aa42b6b47b58..c0318a2f3364 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -27,7 +27,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json index dd28adec3245..20fd1c2f15c2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json index efed4e45c9a9..20f01a6fda3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -26,7 +26,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", @@ -49,7 +49,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index e26581f15b41..ff1009e9c1fc 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "function", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json index 42b69df2b38b..0021cd3ec12c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -32,7 +32,7 @@ "assistant_id": null, "run_id": null, "status": "incomplete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1707298421, "incomplete_at": null, "metadata": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json index ef2a9ff15415..15e95dd58e30 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index c9191a6dec25..7f3456272098 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json index dbf4507564e6..70ae2b1b9da1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -29,7 +29,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 0505342c02f8..28345b1bc1e0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json index eabd6abfbc81..03af4b1a4ebe 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -24,7 +24,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "assistant_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json index aaff859bd202..4813900797ae 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -28,7 +28,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], @@ -52,7 +52,7 @@ } ], "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "incomplete_at": null, "completed_at": 1707298439, "attachments": [], diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 0b27b3e61c16..7db1209e3ac3 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index 29de7d1ef280..544186d8d8ac 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": "null", + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index f516aa44f1cc..3c48a77d5a18 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -22,7 +22,7 @@ "assistant_id": null, "thread_id": "thread_abc123", "status": "complete", - "incomplete_details": "null", + "incomplete_details": null, "completed_at": 1699017614, "incomplete_at": null, "run_id": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index 87b98371bb89..678897d270a5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" From a6605ea14c8a351d2dcdcc0b35f60007ed68bdbc Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 21 Jun 2024 15:48:01 +0200 Subject: [PATCH 39/55] Corrected operationId --- .../list_vector_store_file_batch_files.json | 2 +- .../preview/2024-05-01-preview/assistants_generated.json | 8 +++++--- .../examples/list_vector_store_file_batch_files.json | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json index 9773921e3b69..be54b92a08b5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json @@ -36,5 +36,5 @@ } } }, - "operationId": "ListVectorStoreFiles" + "operationId": "ListVectorStoreFileBatchFiles" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 6575df2fad3c..9a39810aa983 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1945,6 +1945,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files of a given batch.": { + "$ref": "./examples/list_vector_store_file_batch_files.json" + } } } }, @@ -2102,9 +2107,6 @@ } }, "x-ms-examples": { - "Returns a list of vector store files of a given batch.": { - "$ref": "./examples/list_vector_store_file_batch_files.json" - }, "Returns a list of vector store files.": { "$ref": "./examples/list_vector_store_files.json" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json index 9773921e3b69..be54b92a08b5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json @@ -36,5 +36,5 @@ } } }, - "operationId": "ListVectorStoreFiles" + "operationId": "ListVectorStoreFileBatchFiles" } From ab876a135efecc12d7aa4b74f0d35f41a726b949 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 13:16:39 +0200 Subject: [PATCH 40/55] trying out null as a string --- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" From 2fc96a5f56dcf7cff9a44a3eb11a00b8b70776d3 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 13:49:13 +0200 Subject: [PATCH 41/55] Revert "trying out null as a string" This reverts commit ab876a135efecc12d7aa4b74f0d35f41a726b949. --- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" From 3dbb7233e27a5ee9b0a2eef0ac4e1d93a5fb5f36 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 14:09:11 +0200 Subject: [PATCH 42/55] Stringified nulls to make CI happy --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../2024-02-15-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-02-15-preview/update_run.json | 2 +- .../examples/2024-05-01-preview/cancel_run.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../2024-05-01-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-05-01-preview/update_run.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-02-15-preview/examples/update_run.json | 2 +- .../preview/2024-05-01-preview/examples/cancel_run.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-05-01-preview/examples/update_run.json | 2 +- 28 files changed, 30 insertions(+), 30 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index ff1009e9c1fc..e26581f15b41 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "function", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index 15e95dd58e30..ef2a9ff15415 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index 7f3456272098..c9191a6dec25 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 7db1209e3ac3..0b27b3e61c16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index 544186d8d8ac..29de7d1ef280 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": null, + "incomplete_details": "null", "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index 678897d270a5..87b98371bb89 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 5317d558935b..1bfc3127f993 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index b516adecefd2..2adcef3156d6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index 2babffbce6d5..dc5ec5138f39 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index 6dab7987a07e..cc3b4db4912a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index c044c0365b3f..37979acf293a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index ff1009e9c1fc..e26581f15b41 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "function", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json index 15e95dd58e30..ef2a9ff15415 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index 7f3456272098..c9191a6dec25 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": null, + "incomplete_details": "null", "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 28345b1bc1e0..0505342c02f8 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 5fdbcedb411f..199e4fde25e4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 2895df4dce16..16346e2c20bf 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": null, + "incomplete_details": "null", "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 7db1209e3ac3..0b27b3e61c16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index 544186d8d8ac..29de7d1ef280 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": null, + "incomplete_details": "null", "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index 678897d270a5..87b98371bb89 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": null, - "incomplete_details": null, + "incomplete_details": "null", "tools": [ { "type": "code_interpreter" From 532e33653fe275014df31f61088a4bac1f3c5b60 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 14:39:14 +0200 Subject: [PATCH 43/55] Changed the value of instructions for ThreadRun examples. Field not nullable nor optional --- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/list_assistants.json | 4 ++-- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../examples/2024-05-01-preview/retrieve_run.json | 4 ++-- .../2024-05-01-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-05-01-preview/update_run.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_assistants.json | 4 ++-- .../preview/2024-05-01-preview/examples/list_runs.json | 4 ++-- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-05-01-preview/examples/update_run.json | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index 0505342c02f8..b77b09c56ca1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -24,7 +24,7 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json index d7d6ba0fa12d..2e2a78969007 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json @@ -52,7 +52,7 @@ "name": null, "description": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "tools": [], "tool_resources": {}, "metadata": {}, @@ -68,4 +68,4 @@ } }, "operationId": "ListAssistants" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 0b27b3e61c16..46b919fff9a6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -24,7 +24,7 @@ "completed_at": 1699075073, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { @@ -62,7 +62,7 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json index 0ec1a07f3837..13825fa502b1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json @@ -22,7 +22,7 @@ "completed_at": 1699075073, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": null, "tools": [ { @@ -49,4 +49,4 @@ } }, "operationId": "RetrieveRun" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index 29de7d1ef280..d8921e7013d3 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -30,7 +30,7 @@ "completed_at": null, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "tools": [ { "type": "function", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index 87b98371bb89..34836d4d4ab6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -27,7 +27,7 @@ "completed_at": 1699075073, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index 0505342c02f8..b77b09c56ca1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -24,7 +24,7 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json index d7d6ba0fa12d..2e2a78969007 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json @@ -52,7 +52,7 @@ "name": null, "description": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "tools": [], "tool_resources": {}, "metadata": {}, @@ -68,4 +68,4 @@ } }, "operationId": "ListAssistants" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 0b27b3e61c16..46b919fff9a6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -24,7 +24,7 @@ "completed_at": 1699075073, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { @@ -62,7 +62,7 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index 29de7d1ef280..d8921e7013d3 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -30,7 +30,7 @@ "completed_at": null, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "tools": [ { "type": "function", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index 87b98371bb89..34836d4d4ab6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -27,7 +27,7 @@ "completed_at": 1699075073, "last_error": null, "model": "gpt-4-turbo", - "instructions": null, + "instructions": "", "incomplete_details": "null", "tools": [ { From 56d8bb84683a2100cd0d49e7376e2a07bb3c3fff Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 21:14:46 +0200 Subject: [PATCH 44/55] Addressing metadata issue --- .../examples/2024-05-01-preview/update_message.json | 3 +-- .../preview/2024-05-01-preview/examples/update_message.json | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json index 3c48a77d5a18..7621cc8605c7 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -8,8 +8,7 @@ "body": { "metadata": { "modified": "true", - "user": "abc123", - "attachments": [] + "user": "abc123" } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json index 3c48a77d5a18..7621cc8605c7 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -8,8 +8,7 @@ "body": { "metadata": { "modified": "true", - "user": "abc123", - "attachments": [] + "user": "abc123" } } }, From a6811ec444804da9ce0003873c9a8b110698c55b Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 21:27:15 +0200 Subject: [PATCH 45/55] Revert "Stringified nulls to make CI happy" This reverts commit 3dbb7233e27a5ee9b0a2eef0ac4e1d93a5fb5f36. --- .../examples/2024-02-15-preview/cancel_run.json | 2 +- .../examples/2024-02-15-preview/create_run.json | 2 +- .../examples/2024-02-15-preview/create_thread_and_run.json | 2 +- .../examples/2024-02-15-preview/get_run.json | 2 +- .../examples/2024-02-15-preview/list_runs.json | 2 +- .../2024-02-15-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-02-15-preview/update_run.json | 2 +- .../examples/2024-05-01-preview/cancel_run.json | 2 +- .../examples/2024-05-01-preview/create_run.json | 2 +- .../examples/2024-05-01-preview/create_thread_and_run.json | 2 +- .../examples/2024-05-01-preview/get_run.json | 2 +- .../examples/2024-05-01-preview/list_runs.json | 4 ++-- .../2024-05-01-preview/submit_tool_outputs_to_run.json | 2 +- .../examples/2024-05-01-preview/update_run.json | 2 +- .../preview/2024-02-15-preview/examples/cancel_run.json | 2 +- .../preview/2024-02-15-preview/examples/create_run.json | 2 +- .../2024-02-15-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-02-15-preview/examples/get_run.json | 2 +- .../preview/2024-02-15-preview/examples/list_runs.json | 2 +- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-02-15-preview/examples/update_run.json | 2 +- .../preview/2024-05-01-preview/examples/cancel_run.json | 2 +- .../preview/2024-05-01-preview/examples/create_run.json | 2 +- .../2024-05-01-preview/examples/create_thread_and_run.json | 2 +- .../preview/2024-05-01-preview/examples/get_run.json | 2 +- .../preview/2024-05-01-preview/examples/list_runs.json | 7 ++++++- .../examples/submit_tool_outputs_to_run.json | 2 +- .../preview/2024-05-01-preview/examples/update_run.json | 2 +- 28 files changed, 34 insertions(+), 29 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json index e26581f15b41..ff1009e9c1fc 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "function", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json index ef2a9ff15415..15e95dd58e30 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json index c9191a6dec25..7f3456272098 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json index b77b09c56ca1..97d2f5b79785 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json index 46b919fff9a6..e80a557e64c1 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -63,7 +63,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json index d8921e7013d3..cd810dd4169a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": "null", + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json index 34836d4d4ab6..709ed437a3ce 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json index 1bfc3127f993..5317d558935b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -28,7 +28,7 @@ "type": "code_interpreter" } ], - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json index 2adcef3156d6..b516adecefd2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -17,7 +17,7 @@ "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", "status": "queued", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": null, "expires_at": 1707301742, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json index dc5ec5138f39..2babffbce6d5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -26,7 +26,7 @@ "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], "usage": null, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {} } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json index cc3b4db4912a..6dab7987a07e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json index 37979acf293a..c044c0365b3f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -26,7 +26,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": { "completion_tokens": 1, "prompt_tokens": 999, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json index e26581f15b41..ff1009e9c1fc 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -31,7 +31,7 @@ "last_error": null, "model": "gpt-4", "instructions": "You tell the weather.", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "function", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json index ef2a9ff15415..15e95dd58e30 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -30,7 +30,7 @@ "model": "gpt-4-1106-preview", "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", "tools": [], - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "metadata": { "key1": "value1", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json index c9191a6dec25..7f3456272098 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -35,7 +35,7 @@ }, "max_completion_tokens": 1000, "max_prompt_tokens": 1000, - "incomplete_details": "null", + "incomplete_details": null, "metadata": {}, "usage": null, "temperature": 1.0, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json index b77b09c56ca1..97d2f5b79785 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json index 199e4fde25e4..5fdbcedb411f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -43,7 +43,7 @@ "type": "auto", "last_messages": null }, - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "response_format": "auto", "tool_choice": "auto" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json index 16346e2c20bf..2895df4dce16 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -15,7 +15,7 @@ "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", "status": "completed", - "incomplete_details": "null", + "incomplete_details": null, "usage": null, "started_at": 1707303197, "expires_at": null, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index 46b919fff9a6..d17122687bc8 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -25,7 +25,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" @@ -62,8 +62,13 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", +<<<<<<< HEAD "instructions": "", "incomplete_details": "null", +======= + "instructions": null, + "incomplete_details": null, +>>>>>>> parent of 3dbb7233e2 (Stringified nulls to make CI happy) "tools": [ { "type": "code_interpreter" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json index d8921e7013d3..cd810dd4169a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -63,7 +63,7 @@ "usage": null, "temperature": 1.0, "top_p": 1.0, - "incomplete_details": "null", + "incomplete_details": null, "max_prompt_tokens": 1000, "max_completion_tokens": 1000, "truncation_strategy": { diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json index 34836d4d4ab6..709ed437a3ce 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -28,7 +28,7 @@ "last_error": null, "model": "gpt-4-turbo", "instructions": "", - "incomplete_details": "null", + "incomplete_details": null, "tools": [ { "type": "code_interpreter" From 62feec495eac3e5d459758e64a3f8a0b87551c2c Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 25 Jun 2024 21:28:27 +0200 Subject: [PATCH 46/55] Reverting left over stuff --- .../preview/2024-05-01-preview/examples/list_runs.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json index d17122687bc8..e80a557e64c1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -62,13 +62,8 @@ "completed_at": 1699063291, "last_error": null, "model": "gpt-4-turbo", -<<<<<<< HEAD "instructions": "", - "incomplete_details": "null", -======= - "instructions": null, "incomplete_details": null, ->>>>>>> parent of 3dbb7233e2 (Stringified nulls to make CI happy) "tools": [ { "type": "code_interpreter" From d80492110e3af34a7ca1cd2ece7e899ed495d461 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 26 Jun 2024 14:08:14 +0200 Subject: [PATCH 47/55] TSP formatter --- specification/ai/OpenAI.Assistants/runs/routes.tsp | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index 8e8c2ed5c5ea..8f04138feb11 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -28,10 +28,7 @@ namespace Azure.AI.OpenAI.Assistants; @route("/threads/{threadId}/runs") @doc("Creates a new run for an assistant thread.") @added(ServiceApiVersions.v2024_02_15_preview) -op createRun( - @path threadId: string, - ...CreateRunOptions, -): ThreadRun; +op createRun(@path threadId: string, ...CreateRunOptions): ThreadRun; /** * Gets a list of runs for a specified thread. From f95d53311ebadf16401e93698f5dc4b82cbe99c1 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 26 Jun 2024 14:13:22 +0200 Subject: [PATCH 48/55] Prettified JSON --- .../2024-02-15-preview/create_assistant.json | 6 +- .../create_assistant_file.json | 2 +- .../delete_assistant_file.json | 2 +- .../get_assistant_file.json | 2 +- .../2024-02-15-preview/get_message_file.json | 2 +- .../list_assistant_files.json | 2 +- .../2024-02-15-preview/list_file.json | 64 ++++++++--------- .../list_message_files.json | 2 +- .../delete_assistant_file.json | 2 +- .../2024-05-01-preview/delete_message.json | 2 +- .../get_assistant_file.json | 2 +- .../2024-05-01-preview/get_message_file.json | 2 +- .../list_assistant_files.json | 2 +- .../2024-05-01-preview/list_file.json | 72 +++++++++---------- .../list_message_files.json | 2 +- .../2024-05-01-preview/retrieve_message.json | 2 +- .../2024-05-01-preview/retrieve_run_step.json | 2 +- .../examples/create_assistant.json | 6 +- .../examples/list_file.json | 64 ++++++++--------- .../examples/list_file.json | 72 +++++++++---------- 20 files changed, 156 insertions(+), 156 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 5653c6dbc3e4..5a9981a936b5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -7,9 +7,9 @@ "name": "Math Tutor", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ - { - "type": "code_interpreter" - } + { + "type": "code_interpreter" + } ], "model": "gpt-4-1106-preview" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json index 0c8e29c2ac94..d5ae61074fda 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json @@ -19,4 +19,4 @@ } }, "operationId": "CreateAssistantFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json index 3441e64ee68a..c49a03dbe3bd 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json @@ -16,4 +16,4 @@ } }, "operationId": "DeleteAssistantFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json index adaf818b0d67..a87763333188 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json @@ -17,4 +17,4 @@ } }, "operationId": "GetAssistantFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json index 273d292e2286..9a6903b8035d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json @@ -18,4 +18,4 @@ } }, "operationId": "GetMessageFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json index f4b3a7a9e6a0..6e86c19346c6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json @@ -24,4 +24,4 @@ } }, "operationId": "ListAssistantFiles" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json index 77c101dcb045..39b31a4aa1b6 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json @@ -1,34 +1,34 @@ { - "title": "Returns a list of files filtered by purpose", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "purpose": "assistants" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "object": "file", - "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", - "purpose": "assistants", - "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", - "bytes": 4, - "created_at": 1718886199 - }, - { - "object": "file", - "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", - "purpose": "assistants", - "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", - "bytes": 4, - "created_at": 1718886043 - } - ] - } + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] } - }, - "operationId": "ListFiles" - } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json index 4590f712a037..7845dc8727bf 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json @@ -31,4 +31,4 @@ } }, "operationId": "ListMessageFiles" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json index 58af130970e4..0477f10eea3d 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json @@ -16,4 +16,4 @@ } }, "operationId": "DeleteAssistantFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json index 8e094454cf8b..62b256cd944f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json @@ -16,4 +16,4 @@ } }, "operationId": "DeleteMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json index b89adb764a2c..516112e3f17f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json @@ -17,4 +17,4 @@ } }, "operationId": "GetAssistantFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json index a3f365ff39dc..a3351efdc669 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json @@ -18,4 +18,4 @@ } }, "operationId": "GetMessageFile" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json index 837f7ee7186f..2e1141b33dd9 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json @@ -24,4 +24,4 @@ } }, "operationId": "ListAssistantFiles" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json index 8ad3b6699500..a8c406924328 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json @@ -1,38 +1,38 @@ { - "title": "Returns a list of files filtered by purpose", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "purpose": "assistants" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "object": "file", - "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", - "purpose": "assistants", - "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", - "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null - }, - { - "object": "file", - "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", - "purpose": "assistants", - "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", - "bytes": 4, - "created_at": 1718886043, - "status": "processed", - "status_details": null - } - ] - } + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] } - }, - "operationId": "ListFiles" - } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json index f52196d97367..4cdfebbfc22a 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json @@ -31,4 +31,4 @@ } }, "operationId": "ListMessageFiles" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json index 372a25ccb600..e971b367433f 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json @@ -31,4 +31,4 @@ } }, "operationId": "RetrieveMessage" -} \ No newline at end of file +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json index 9aafcb1f6ebd..f111731004a4 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json @@ -38,4 +38,4 @@ } }, "operationId": "RetrieveRunStep" -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json index 5653c6dbc3e4..5a9981a936b5 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -7,9 +7,9 @@ "name": "Math Tutor", "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", "tools": [ - { - "type": "code_interpreter" - } + { + "type": "code_interpreter" + } ], "model": "gpt-4-1106-preview" } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json index 77c101dcb045..39b31a4aa1b6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json @@ -1,34 +1,34 @@ { - "title": "Returns a list of files filtered by purpose", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "purpose": "assistants" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "object": "file", - "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", - "purpose": "assistants", - "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", - "bytes": 4, - "created_at": 1718886199 - }, - { - "object": "file", - "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", - "purpose": "assistants", - "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", - "bytes": 4, - "created_at": 1718886043 - } - ] - } + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] } - }, - "operationId": "ListFiles" - } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json index 8ad3b6699500..a8c406924328 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json @@ -1,38 +1,38 @@ { - "title": "Returns a list of files filtered by purpose", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "purpose": "assistants" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "object": "file", - "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", - "purpose": "assistants", - "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", - "bytes": 4, - "created_at": 1718886199, - "status": "processed", - "status_details": null - }, - { - "object": "file", - "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", - "purpose": "assistants", - "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", - "bytes": 4, - "created_at": 1718886043, - "status": "processed", - "status_details": null - } - ] - } + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] } - }, - "operationId": "ListFiles" - } + } + }, + "operationId": "ListFiles" +} From 88c80757c56428ef2f1e7cc8695cce71f8af691e Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 27 Jun 2024 09:29:53 +0200 Subject: [PATCH 49/55] Added suppresion to work around bug --- specification/ai/data-plane/OpenAI.Assistants/readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md index d4fcc01f7383..5733840ef282 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/readme.md +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -12,6 +12,15 @@ add-credentials: true openapi-type: data-plane ``` +## Suppression + +``` yaml +directive: + - suppress: INVALID_TYPE + from: assistants_generated.json + reason: A bug in oav is preventing a x-nullable attribute on incomplete_details from being honored. +``` + # Releases ## OpenAI.Assistants 2024-02-15-preview (generated) From 8e6e8820b8135c5799ddac2aeeba04a79eccdbc2 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 27 Jun 2024 10:14:51 +0200 Subject: [PATCH 50/55] Removed unnecessary example files --- .../create_assistant_file.json | 22 -------- .../delete_assistant_file.json | 19 ------- .../get_assistant_file.json | 20 ------- .../2024-02-15-preview/get_message_file.json | 21 -------- .../list_assistant_files.json | 27 ---------- .../list_message_files.json | 34 ------------ .../delete_assistant_file.json | 19 ------- .../2024-05-01-preview/delete_message.json | 19 ------- .../get_assistant_file.json | 20 ------- .../2024-05-01-preview/get_message_file.json | 21 -------- .../list_assistant_files.json | 27 ---------- .../list_message_files.json | 34 ------------ .../list_vector_store_file_batch.json | 34 ------------ .../2024-05-01-preview/retrieve_message.json | 34 ------------ .../2024-05-01-preview/retrieve_run.json | 52 ------------------- .../2024-05-01-preview/retrieve_run_step.json | 41 --------------- .../OpenAI.Assistants/examples/file_diff.py | 46 ++++++++++++++++ 17 files changed, 46 insertions(+), 444 deletions(-) delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json delete mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/file_diff.py diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json deleted file mode 100644 index d5ae61074fda..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant_file.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "title": "Create an assistant file.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", - "body": { - "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" - } - }, - "responses": { - "200": { - "body": { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file", - "created_at": 1707324164, - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - } - } - }, - "operationId": "CreateAssistantFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json deleted file mode 100644 index c49a03dbe3bd..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant_file.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "title": "Deletes an AssistantFile.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", - "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" - }, - "responses": { - "200": { - "body": { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file.deleted", - "deleted": true - } - } - }, - "operationId": "DeleteAssistantFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json deleted file mode 100644 index a87763333188..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant_file.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "title": "Retrieves an AssistantFile.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", - "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" - }, - "responses": { - "200": { - "body": { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file", - "created_at": 1707324164, - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - } - } - }, - "operationId": "GetAssistantFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json deleted file mode 100644 index 9a6903b8035d..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message_file.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "title": "Retrieves a message file.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123", - "file_id": "file_abc123" - }, - "responses": { - "200": { - "body": { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - } - } - }, - "operationId": "GetMessageFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json deleted file mode 100644 index 6e86c19346c6..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistant_files.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "title": "Returns a list of assistant files.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file", - "created_at": 1707324164, - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - } - ], - "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "has_more": false - } - } - }, - "operationId": "ListAssistantFiles" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json deleted file mode 100644 index 7845dc8727bf..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_message_files.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "Returns a list of message files.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-02-15-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - }, - { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - } - ], - "first_id": "file-abc123", - "last_id": "file-abc123", - "has_more": false - } - } - }, - "operationId": "ListMessageFiles" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json deleted file mode 100644 index 0477f10eea3d..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant_file.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "title": "Deletes an AssistantFile.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", - "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" - }, - "responses": { - "200": { - "body": { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file.deleted", - "deleted": true - } - } - }, - "operationId": "DeleteAssistantFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json deleted file mode 100644 index 62b256cd944f..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_message.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "title": "Deletes a message.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123" - }, - "responses": { - "200": { - "body": { - "id": "msg_abc123", - "object": "thread.message.deleted", - "deleted": true - } - } - }, - "operationId": "DeleteMessage" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json deleted file mode 100644 index 516112e3f17f..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant_file.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "title": "Retrieves an AssistantFile.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", - "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" - }, - "responses": { - "200": { - "body": { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file", - "created_at": 1707324164, - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - } - } - }, - "operationId": "GetAssistantFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json deleted file mode 100644 index a3351efdc669..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message_file.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "title": "Retrieves a message file.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123", - "file_id": "file_abc123" - }, - "responses": { - "200": { - "body": { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - } - } - }, - "operationId": "GetMessageFile" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json deleted file mode 100644 index 2e1141b33dd9..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistant_files.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "title": "Returns a list of assistant files.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "object": "assistant.file", - "created_at": 1707324164, - "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" - } - ], - "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", - "has_more": false - } - } - }, - "operationId": "ListAssistantFiles" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json deleted file mode 100644 index 4cdfebbfc22a..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_message_files.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "Returns a list of message files.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - }, - { - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" - } - ], - "first_id": "file-abc123", - "last_id": "file-abc123", - "has_more": false - } - } - }, - "operationId": "ListMessageFiles" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json deleted file mode 100644 index 1319d24cd442..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "Returns a list of vector store files in a batch.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "vectorStoreId": "vs_abc123", - "batchId": "vsfb_abc123" - }, - "responses": { - "200": { - "body": { - "object": "list", - "data": [ - { - "id": "file-abc123", - "object": "vector_store.file", - "created_at": 1699061776, - "vector_store_id": "vs_abc123" - }, - { - "id": "file-abc456", - "object": "vector_store.file", - "created_at": 1699061776, - "vector_store_id": "vs_abc123" - } - ], - "first_id": "file-abc123", - "last_id": "file-abc456", - "has_more": false - } - } - }, - "operationId": "ListVectorStoreFileBatch" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json deleted file mode 100644 index e971b367433f..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_message.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "Retrieves a message.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "message_id": "msg_abc123" - }, - "responses": { - "200": { - "body": { - "id": "msg_abc123", - "object": "thread.message", - "created_at": 1699017614, - "assistant_id": null, - "thread_id": "thread_abc123", - "run_id": null, - "role": "user", - "content": [ - { - "type": "text", - "text": { - "value": "How does AI work? Explain it in simple terms.", - "annotations": [] - } - } - ], - "attachments": [], - "metadata": {} - } - } - }, - "operationId": "RetrieveMessage" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json deleted file mode 100644 index 13825fa502b1..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "title": "Retrieves a run.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123" - }, - "responses": { - "200": { - "body": { - "id": "run_abc123", - "object": "thread.run", - "created_at": 1699075072, - "assistant_id": "asst_abc123", - "thread_id": "thread_abc123", - "status": "completed", - "started_at": 1699075072, - "expires_at": null, - "cancelled_at": null, - "failed_at": null, - "completed_at": 1699075073, - "last_error": null, - "model": "gpt-4-turbo", - "instructions": "", - "incomplete_details": null, - "tools": [ - { - "type": "code_interpreter" - } - ], - "metadata": {}, - "usage": { - "prompt_tokens": 123, - "completion_tokens": 456, - "total_tokens": 579 - }, - "temperature": 1.0, - "top_p": 1.0, - "max_prompt_tokens": 1000, - "max_completion_tokens": 1000, - "truncation_strategy": { - "type": "auto", - "last_messages": null - }, - "response_format": "auto", - "tool_choice": "auto" - } - } - }, - "operationId": "RetrieveRun" -} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json deleted file mode 100644 index f111731004a4..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/retrieve_run_step.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "title": "Retrieves a run step.", - "parameters": { - "endpoint": "{endpoint}", - "api-version": "2024-05-01-preview", - "thread_id": "thread_abc123", - "run_id": "run_abc123", - "step_id": "step_abc123" - }, - "responses": { - "200": { - "body": { - "id": "step_abc123", - "object": "thread.run.step", - "created_at": 1699063291, - "run_id": "run_abc123", - "assistant_id": "asst_abc123", - "thread_id": "thread_abc123", - "type": "message_creation", - "status": "completed", - "cancelled_at": null, - "completed_at": 1699063291, - "expired_at": null, - "failed_at": null, - "last_error": null, - "step_details": { - "type": "message_creation", - "message_creation": { - "message_id": "msg_abc123" - } - }, - "usage": { - "prompt_tokens": 123, - "completion_tokens": 456, - "total_tokens": 579 - } - } - } - }, - "operationId": "RetrieveRunStep" -} diff --git a/specification/ai/OpenAI.Assistants/examples/file_diff.py b/specification/ai/OpenAI.Assistants/examples/file_diff.py new file mode 100644 index 000000000000..8c42677e4e28 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/file_diff.py @@ -0,0 +1,46 @@ +#!/usr/bin/env python3 + +import pathlib + + +# Run script from `specifications/ai` folder +def compare_folders(folder1, folder2): + # Convert to Path objects for easier manipulation + folder1_path = pathlib.Path(folder1) + folder2_path = pathlib.Path(folder2) + + # Get sets of .json file names in each folder + files_in_folder1 = {file.name for file in folder1_path.glob("*.json")} + files_in_folder2 = {file.name for file in folder2_path.glob("*.json")} + + # Find differences + missing_in_folder1 = files_in_folder2 - files_in_folder1 + missing_in_folder2 = files_in_folder1 - files_in_folder2 + + # Print results + print(f"Files in '{folder2}' missing in '{folder1}':") + for file in sorted(missing_in_folder1): + print(f"- {file}") + + print(f"\nFiles in '{folder1}' missing in '{folder2}':") + for file in sorted(missing_in_folder2): + print(f"- {file}") + + +# Define folder pairs to compare +folder_pairs = [ + ( + "OpenAI.Assistants/examples/2024-02-15-preview", + "data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples", + ), + ( + "OpenAI.Assistants/examples/2024-05-01-preview", + "data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples", + ), +] + +# Compare each pair of folders +for folder1, folder2 in folder_pairs: + print(f"Comparing '{folder1}' and '{folder2}':") + compare_folders(folder1, folder2) + print("\n" + "-" * 50 + "\n") From 48ed512cbc930d7c5f71a2bf371c25f6cb46c554 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Thu, 27 Jun 2024 10:32:07 +0200 Subject: [PATCH 51/55] Removed convenience scripts --- .../examples/add_operation_id.py | 38 --------------- .../OpenAI.Assistants/examples/file_diff.py | 46 ------------------- 2 files changed, 84 deletions(-) delete mode 100644 specification/ai/OpenAI.Assistants/examples/add_operation_id.py delete mode 100644 specification/ai/OpenAI.Assistants/examples/file_diff.py diff --git a/specification/ai/OpenAI.Assistants/examples/add_operation_id.py b/specification/ai/OpenAI.Assistants/examples/add_operation_id.py deleted file mode 100644 index a0d06a05da39..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/add_operation_id.py +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env python3 - -import json -import pathlib - -# README: this script assumes you are running it from OpenAI.Assistants/examples -# USAGE: run the command `py .\add_operatio_id.py` - -# Function to convert snake case to Pascal case -def snake_to_pascal(name): - # Split the name by underscores, capitalize each word, then join them together - return ''.join(word.title() for word in name.split('_')) - -# Define the base path as the current directory -base_path = pathlib.Path('.') -# Define the versions of the JSON files to process -versions = ['2024-02-15-preview', '2024-05-01-preview'] - -# Loop over each version -for version in versions: - # Loop over each JSON file in the current version directory - for json_file in (base_path / version).glob('*.json'): - print(f"Processing file: {json_file}") # Print the file being processed - try: - # Open the JSON file and load its contents - with json_file.open() as f: - data = json.load(f) - - # Convert the file name (without extension) from snake case to Pascal case - operation_id = snake_to_pascal(json_file.stem) - # Add the operation ID to the JSON data - data['operationId'] = operation_id - - # Open the JSON file again (in write mode this time) and write the updated data - with json_file.open('w') as f: - json.dump(data, f, indent=2) - except Exception as e: - print(f"Error processing file {json_file}: {e}") # Print any errors that occurls diff --git a/specification/ai/OpenAI.Assistants/examples/file_diff.py b/specification/ai/OpenAI.Assistants/examples/file_diff.py deleted file mode 100644 index 8c42677e4e28..000000000000 --- a/specification/ai/OpenAI.Assistants/examples/file_diff.py +++ /dev/null @@ -1,46 +0,0 @@ -#!/usr/bin/env python3 - -import pathlib - - -# Run script from `specifications/ai` folder -def compare_folders(folder1, folder2): - # Convert to Path objects for easier manipulation - folder1_path = pathlib.Path(folder1) - folder2_path = pathlib.Path(folder2) - - # Get sets of .json file names in each folder - files_in_folder1 = {file.name for file in folder1_path.glob("*.json")} - files_in_folder2 = {file.name for file in folder2_path.glob("*.json")} - - # Find differences - missing_in_folder1 = files_in_folder2 - files_in_folder1 - missing_in_folder2 = files_in_folder1 - files_in_folder2 - - # Print results - print(f"Files in '{folder2}' missing in '{folder1}':") - for file in sorted(missing_in_folder1): - print(f"- {file}") - - print(f"\nFiles in '{folder1}' missing in '{folder2}':") - for file in sorted(missing_in_folder2): - print(f"- {file}") - - -# Define folder pairs to compare -folder_pairs = [ - ( - "OpenAI.Assistants/examples/2024-02-15-preview", - "data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples", - ), - ( - "OpenAI.Assistants/examples/2024-05-01-preview", - "data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples", - ), -] - -# Compare each pair of folders -for folder1, folder2 in folder_pairs: - print(f"Comparing '{folder1}' and '{folder2}':") - compare_folders(folder1, folder2) - print("\n" + "-" * 50 + "\n") From a31f2a05e95d0bd4f13063ee44766ee8484bba32 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 28 Jun 2024 10:55:50 +0200 Subject: [PATCH 52/55] Using bodyRoot again --- specification/ai/OpenAI.Assistants/messages/routes.tsp | 4 +++- .../preview/2024-02-15-preview/assistants_generated.json | 3 ++- .../preview/2024-05-01-preview/assistants_generated.json | 3 ++- .../OpenApiV3/2024-02-15-preview/assistants_generated.yaml | 1 + .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 1 + 5 files changed, 9 insertions(+), 3 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 4021a83ce71f..f6067c01d2ed 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -32,7 +32,9 @@ op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - ...ThreadMessageOptions, + @added(ServiceApiVersions.v2024_02_15_preview) + @bodyRoot + threadMessageOptions: ThreadMessageOptions, ): ThreadMessage; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 394b65b433f4..88a51345c319 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -759,8 +759,9 @@ "type": "string" }, { - "name": "body", + "name": "threadMessageOptions", "in": "body", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index bd7ad9148ab1..b7a77b9a2095 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -802,8 +802,9 @@ "type": "string" }, { - "name": "body", + "name": "threadMessageOptions", "in": "body", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 1ae71b3ab70f..6850d69ce24a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -367,6 +367,7 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index cc3ac3ff9e24..2ec4fb998942 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -367,6 +367,7 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. required: true content: application/json: From 7b261738c15243571b004dbceceeb8fec97ef895 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 28 Jun 2024 11:14:17 +0200 Subject: [PATCH 53/55] Revert "Using bodyRoot again" This reverts commit a31f2a05e95d0bd4f13063ee44766ee8484bba32. --- specification/ai/OpenAI.Assistants/messages/routes.tsp | 4 +--- .../preview/2024-02-15-preview/assistants_generated.json | 3 +-- .../preview/2024-05-01-preview/assistants_generated.json | 3 +-- .../OpenApiV3/2024-02-15-preview/assistants_generated.yaml | 1 - .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 1 - 5 files changed, 3 insertions(+), 9 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index f6067c01d2ed..4021a83ce71f 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -32,9 +32,7 @@ op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - @added(ServiceApiVersions.v2024_02_15_preview) - @bodyRoot - threadMessageOptions: ThreadMessageOptions, + ...ThreadMessageOptions, ): ThreadMessage; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 88a51345c319..394b65b433f4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -759,9 +759,8 @@ "type": "string" }, { - "name": "threadMessageOptions", + "name": "body", "in": "body", - "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index b7a77b9a2095..bd7ad9148ab1 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -802,9 +802,8 @@ "type": "string" }, { - "name": "threadMessageOptions", + "name": "body", "in": "body", - "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 6850d69ce24a..1ae71b3ab70f 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -367,7 +367,6 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: - description: A single message within an assistant thread, as provided during that thread's creation for its initial state. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index 2ec4fb998942..cc3ac3ff9e24 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -367,7 +367,6 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: - description: A single message within an assistant thread, as provided during that thread's creation for its initial state. required: true content: application/json: From 3d997c7205efb124fef0ceb1aa345b9f7993ab64 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 2 Jul 2024 10:26:09 +0200 Subject: [PATCH 54/55] Using BodyParameter in createMessage op --- specification/ai/OpenAI.Assistants/messages/routes.tsp | 2 +- .../preview/2024-02-15-preview/assistants_generated.json | 1 + .../preview/2024-05-01-preview/assistants_generated.json | 1 + .../OpenApiV3/2024-02-15-preview/assistants_generated.yaml | 1 + .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 1 + 5 files changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 4021a83ce71f..181f50433021 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -32,7 +32,7 @@ op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - ...ThreadMessageOptions, + ...BodyParameter, ): ThreadMessage; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 394b65b433f4..df03da8c2ff9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -761,6 +761,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index bd7ad9148ab1..4ebb174b0ff6 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -804,6 +804,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 1ae71b3ab70f..f9a9e7602c4a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -367,6 +367,7 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: + description: Body parameter. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index cc3ac3ff9e24..06b82c2dbc1c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -367,6 +367,7 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: + description: Body parameter. required: true content: application/json: From dd40d478af590f67d5a8087e82a36435efdc97d1 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 2 Jul 2024 11:50:27 +0200 Subject: [PATCH 55/55] The CI seems stuck