diff --git a/specification/ai/Azure.AI.Projects/common/models.tsp b/specification/ai/Azure.AI.Projects/common/models.tsp index 8ed2b8786f34..86858eb0f339 100644 --- a/specification/ai/Azure.AI.Projects/common/models.tsp +++ b/specification/ai/Azure.AI.Projects/common/models.tsp @@ -7,37 +7,8 @@ using TypeSpec.Http; namespace Azure.AI.Projects; -@doc("The available sorting options when requesting a list of response objects.") -union ListSortOrder { - string, - - @doc("Specifies an ascending sort order.") - ascending: "asc", - - @doc("Specifies a descending sort order.") - descending: "desc", -} - -@doc("List View Type Definition") -union ListViewType { - string, - - @doc("List only active items.") - ActiveOnly: "ActiveOnly", - - @doc("List only archived items.") - ArchivedOnly: "ArchivedOnly", - - @doc("List all items.") - All: "All", -} - alias AssetBase = { - @doc("Asset stage") - @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) - stage?: string; - - @doc("A unique identifier for the asset, assetId probably?") + @doc("Asset ID, a unique identifier for the asset") @visibility(Lifecycle.Read) id?: string; @@ -79,8 +50,8 @@ union PendingUploadType { @doc("No pending upload.") none: "None", - @doc("Temporary Blob Reference is the only supported type.") - temporaryBlobReference: "TemporaryBlobReference", + @doc("Blob Reference is the only supported type.") + BlobReference: "BlobReference", } @doc("The type of credential used to access the storage account.") @@ -99,23 +70,23 @@ model PendingUploadRequest { @doc("Name of Azure blob storage connection to use for generating temporary SAS token") connectionName?: string; - @doc("TemporaryBlobReference is the only supported type.") - pendingUploadType: PendingUploadType.temporaryBlobReference; + @doc("BlobReference is the only supported type.") + pendingUploadType: PendingUploadType.BlobReference; } @doc("Represents the response for a pending upload request") model PendingUploadResponse { @doc("Container-level read, write, list SAS.") - blobReferenceForConsumption: BlobReferenceForConsumption; + blobReference: BlobReference; @doc("ID for this upload request.") pendingUploadId: string; - @doc("Version of dataset to be created if user did not specify version when initially creating upload") - datasetVersion?: string; + @doc("Version of asset to be created if user did not specify version when initially creating upload") + version?: string; @doc("TemporaryBlobReference is the only supported type") - pendingUploadType: PendingUploadType.temporaryBlobReference; + pendingUploadType: PendingUploadType.BlobReference; } @doc("SAS Credential definition") @@ -129,8 +100,8 @@ model SasCredential { type: "SAS"; } -@doc("Represents a reference to a blob for consumption") -model BlobReferenceForConsumption { +@doc("Blob reference details.") +model BlobReference { @doc("Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path") blobUri: Uri; @@ -144,5 +115,5 @@ model BlobReferenceForConsumption { @doc("Represents a reference to a blob for consumption") model AssetCredentialResponse { @doc("Credential info to access the storage account.") - blobReferenceForConsumption: BlobReferenceForConsumption; + blobReference: BlobReference; } diff --git a/specification/ai/Azure.AI.Projects/datasets/models.tsp b/specification/ai/Azure.AI.Projects/datasets/models.tsp index e8f23ef6404f..f371c6c2e745 100644 --- a/specification/ai/Azure.AI.Projects/datasets/models.tsp +++ b/specification/ai/Azure.AI.Projects/datasets/models.tsp @@ -32,7 +32,7 @@ model DatasetVersion { @visibility(Lifecycle.Read, Lifecycle.Create) @minLength(1) @pattern("[a-zA-Z0-9_]") - datasetUri: string; + dataUri: string; @doc("Dataset type") type: DatasetType; @@ -49,9 +49,6 @@ model DatasetVersion { model FileDatasetVersion extends DatasetVersion { @doc("Dataset type") type: DatasetType.uri_file; - - @doc("Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features") - openAIPurpose: string; } @doc("FileDatasetVersion Definition") diff --git a/specification/ai/Azure.AI.Projects/datasets/routes.tsp b/specification/ai/Azure.AI.Projects/datasets/routes.tsp index dc283e2a7c79..8a359758efc3 100644 --- a/specification/ai/Azure.AI.Projects/datasets/routes.tsp +++ b/specification/ai/Azure.AI.Projects/datasets/routes.tsp @@ -13,21 +13,9 @@ using TypeSpec.Versioning; namespace Azure.AI.Projects; alias ListDatasetVersionsParameters = { - @doc("Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned") - @query - top?: int32; - @doc("Continuation token for pagination.") @query - skip?: string; - - @doc("Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2") - @query - tags?: string; - - @doc("[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.") - @query - listViewType?: ListViewType; + continuationToken?: string; }; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We are using service specific operation templates" diff --git a/specification/ai/Azure.AI.Projects/indexes/routes.tsp b/specification/ai/Azure.AI.Projects/indexes/routes.tsp index af56cb0149e4..d01c5d9fb166 100644 --- a/specification/ai/Azure.AI.Projects/indexes/routes.tsp +++ b/specification/ai/Azure.AI.Projects/indexes/routes.tsp @@ -12,21 +12,9 @@ using TypeSpec.Versioning; namespace Azure.AI.Projects; alias ListIndexVersionParameters = { - @doc("Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned") - @query - top?: int32; - @doc("Continuation token for pagination.") @query - skip?: string; - - @doc("Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2") - @query - tags?: string; - - @doc("[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.") - @query - listViewType?: ListViewType; + continuationToken?: string; }; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We are using service specific operation templates" diff --git a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects-1dp.json b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects-1dp.json index 4f0f9d90e970..3489f4f51648 100644 --- a/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects-1dp.json +++ b/specification/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects-1dp.json @@ -301,59 +301,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -405,59 +357,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1146,59 +1050,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1250,59 +1106,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1843,13 +1651,13 @@ "type": "object", "description": "Represents a reference to a blob for consumption", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Credential info to access the storage account." } }, "required": [ - "blobReferenceForConsumption" + "blobReference" ] }, "AttackStrategy": { @@ -2143,9 +1951,9 @@ "type" ] }, - "BlobReferenceForConsumption": { + "BlobReference": { "type": "object", - "description": "Represents a reference to a blob for consumption", + "description": "Blob reference details.", "properties": { "blobUri": { "type": "string", @@ -2428,7 +2236,7 @@ "type": "object", "description": "DatasetVersion Definition", "properties": { - "datasetUri": { + "dataUri": { "type": "string", "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", "minLength": 1, @@ -2447,18 +2255,9 @@ "description": "Indicates if dataset is reference only or managed by dataset service. If true, the underlying data will be deleted when the dataset version is deleted", "readOnly": true }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -2493,7 +2292,7 @@ }, "discriminator": "type", "required": [ - "datasetUri", + "dataUri", "type", "name", "version" @@ -2507,15 +2306,6 @@ "$ref": "#/definitions/DatasetType", "description": "Dataset type" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -2695,15 +2485,6 @@ "FileDatasetVersion": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, - "required": [ - "openAIPurpose" - ], "allOf": [ { "$ref": "#/definitions/DatasetVersion" @@ -2714,12 +2495,6 @@ "FileDatasetVersionUpdate": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, "allOf": [ { "$ref": "#/definitions/DatasetVersionUpdate" @@ -2755,18 +2530,9 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -2843,15 +2609,6 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -2910,60 +2667,6 @@ ], "x-ms-discriminator-value": "dataset" }, - "ListSortOrder": { - "type": "string", - "description": "The available sorting options when requesting a list of response objects.", - "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." - } - ] - } - }, - "ListViewType": { - "type": "string", - "description": "List View Type Definition", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } - }, "ManagedAzureAISearchIndex": { "type": "object", "description": "Managed Azure AI Search Index Definition", @@ -3219,9 +2922,9 @@ }, "pendingUploadType": { "type": "string", - "description": "TemporaryBlobReference is the only supported type.", + "description": "BlobReference is the only supported type.", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -3236,23 +2939,23 @@ "type": "object", "description": "Represents the response for a pending upload request", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Container-level read, write, list SAS." }, "pendingUploadId": { "type": "string", "description": "ID for this upload request." }, - "datasetVersion": { + "version": { "type": "string", - "description": "Version of dataset to be created if user did not specify version when initially creating upload" + "description": "Version of asset to be created if user did not specify version when initially creating upload" }, "pendingUploadType": { "type": "string", "description": "TemporaryBlobReference is the only supported type", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -3260,7 +2963,7 @@ } }, "required": [ - "blobReferenceForConsumption", + "blobReference", "pendingUploadId", "pendingUploadType" ] @@ -3270,7 +2973,7 @@ "description": "The type of pending upload.", "enum": [ "None", - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "name": "PendingUploadType", @@ -3282,9 +2985,9 @@ "description": "No pending upload." }, { - "name": "temporaryBlobReference", - "value": "TemporaryBlobReference", - "description": "Temporary Blob Reference is the only supported type." + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." } ] } diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects-1dp.json b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects-1dp.json index 6828e8cba4f4..0604659116eb 100644 --- a/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects-1dp.json +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects-1dp.json @@ -301,59 +301,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -405,59 +357,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -939,59 +843,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1043,59 +899,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1322,13 +1130,13 @@ "type": "object", "description": "Represents a reference to a blob for consumption", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Credential info to access the storage account." } }, "required": [ - "blobReferenceForConsumption" + "blobReference" ] }, "Azure.Core.Foundations.Error": { @@ -1447,9 +1255,9 @@ "type" ] }, - "BlobReferenceForConsumption": { + "BlobReference": { "type": "object", - "description": "Represents a reference to a blob for consumption", + "description": "Blob reference details.", "properties": { "blobUri": { "type": "string", @@ -1732,7 +1540,7 @@ "type": "object", "description": "DatasetVersion Definition", "properties": { - "datasetUri": { + "dataUri": { "type": "string", "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", "minLength": 1, @@ -1751,18 +1559,9 @@ "description": "Indicates if dataset is reference only or managed by dataset service. If true, the underlying data will be deleted when the dataset version is deleted", "readOnly": true }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -1797,7 +1596,7 @@ }, "discriminator": "type", "required": [ - "datasetUri", + "dataUri", "type", "name", "version" @@ -1811,15 +1610,6 @@ "$ref": "#/definitions/DatasetType", "description": "Dataset type" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -1919,15 +1709,6 @@ "FileDatasetVersion": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, - "required": [ - "openAIPurpose" - ], "allOf": [ { "$ref": "#/definitions/DatasetVersion" @@ -1938,12 +1719,6 @@ "FileDatasetVersionUpdate": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, "allOf": [ { "$ref": "#/definitions/DatasetVersionUpdate" @@ -1979,18 +1754,9 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -2067,15 +1833,6 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -2101,60 +1858,6 @@ "type" ] }, - "ListSortOrder": { - "type": "string", - "description": "The available sorting options when requesting a list of response objects.", - "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." - } - ] - } - }, - "ListViewType": { - "type": "string", - "description": "List View Type Definition", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } - }, "ManagedAzureAISearchIndex": { "type": "object", "description": "Managed Azure AI Search Index Definition", @@ -2367,9 +2070,9 @@ }, "pendingUploadType": { "type": "string", - "description": "TemporaryBlobReference is the only supported type.", + "description": "BlobReference is the only supported type.", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -2384,23 +2087,23 @@ "type": "object", "description": "Represents the response for a pending upload request", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Container-level read, write, list SAS." }, "pendingUploadId": { "type": "string", "description": "ID for this upload request." }, - "datasetVersion": { + "version": { "type": "string", - "description": "Version of dataset to be created if user did not specify version when initially creating upload" + "description": "Version of asset to be created if user did not specify version when initially creating upload" }, "pendingUploadType": { "type": "string", "description": "TemporaryBlobReference is the only supported type", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -2408,7 +2111,7 @@ } }, "required": [ - "blobReferenceForConsumption", + "blobReference", "pendingUploadId", "pendingUploadType" ] @@ -2418,7 +2121,7 @@ "description": "The type of pending upload.", "enum": [ "None", - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "name": "PendingUploadType", @@ -2430,9 +2133,9 @@ "description": "No pending upload." }, { - "name": "temporaryBlobReference", - "value": "TemporaryBlobReference", - "description": "Temporary Blob Reference is the only supported type." + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." } ] } diff --git a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects-1dp.json b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects-1dp.json index 72d868f6dc04..195635ee0e74 100644 --- a/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects-1dp.json +++ b/specification/ai/data-plane/Azure.AI.Projects/stable/v1/azure-ai-projects-1dp.json @@ -301,59 +301,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -405,59 +357,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -939,59 +843,11 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1043,59 +899,11 @@ "type": "string" }, { - "name": "top", - "in": "query", - "description": "Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "skip", + "name": "continuationToken", "in": "query", "description": "Continuation token for pagination.", "required": false, "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "required": false, - "type": "string" - }, - { - "name": "listViewType", - "in": "query", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All] View type for including/excluding (for example) archived entities.", - "required": false, - "type": "string", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } } ], "responses": { @@ -1322,13 +1130,13 @@ "type": "object", "description": "Represents a reference to a blob for consumption", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Credential info to access the storage account." } }, "required": [ - "blobReferenceForConsumption" + "blobReference" ] }, "Azure.Core.Foundations.Error": { @@ -1447,9 +1255,9 @@ "type" ] }, - "BlobReferenceForConsumption": { + "BlobReference": { "type": "object", - "description": "Represents a reference to a blob for consumption", + "description": "Blob reference details.", "properties": { "blobUri": { "type": "string", @@ -1732,7 +1540,7 @@ "type": "object", "description": "DatasetVersion Definition", "properties": { - "datasetUri": { + "dataUri": { "type": "string", "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", "minLength": 1, @@ -1751,18 +1559,9 @@ "description": "Indicates if dataset is reference only or managed by dataset service. If true, the underlying data will be deleted when the dataset version is deleted", "readOnly": true }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -1797,7 +1596,7 @@ }, "discriminator": "type", "required": [ - "datasetUri", + "dataUri", "type", "name", "version" @@ -1811,15 +1610,6 @@ "$ref": "#/definitions/DatasetType", "description": "Dataset type" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -1919,15 +1709,6 @@ "FileDatasetVersion": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, - "required": [ - "openAIPurpose" - ], "allOf": [ { "$ref": "#/definitions/DatasetVersion" @@ -1938,12 +1719,6 @@ "FileDatasetVersionUpdate": { "type": "object", "description": "FileDatasetVersion Definition", - "properties": { - "openAIPurpose": { - "type": "string", - "description": "Indicates OpenAI Purpose. FileDatasets created with this field will be compatible with OpenAI-specific features" - } - }, "allOf": [ { "$ref": "#/definitions/DatasetVersionUpdate" @@ -1979,18 +1754,9 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "id": { "type": "string", - "description": "A unique identifier for the asset, assetId probably?", + "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { @@ -2067,15 +1833,6 @@ "$ref": "#/definitions/IndexType", "description": "Type of index" }, - "stage": { - "type": "string", - "description": "Asset stage", - "x-ms-mutability": [ - "read", - "update", - "create" - ] - }, "description": { "type": "string", "description": "The asset description text.", @@ -2101,60 +1858,6 @@ "type" ] }, - "ListSortOrder": { - "type": "string", - "description": "The available sorting options when requesting a list of response objects.", - "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." - } - ] - } - }, - "ListViewType": { - "type": "string", - "description": "List View Type Definition", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "name": "ActiveOnly", - "value": "ActiveOnly", - "description": "List only active items." - }, - { - "name": "ArchivedOnly", - "value": "ArchivedOnly", - "description": "List only archived items." - }, - { - "name": "All", - "value": "All", - "description": "List all items." - } - ] - } - }, "ManagedAzureAISearchIndex": { "type": "object", "description": "Managed Azure AI Search Index Definition", @@ -2367,9 +2070,9 @@ }, "pendingUploadType": { "type": "string", - "description": "TemporaryBlobReference is the only supported type.", + "description": "BlobReference is the only supported type.", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -2384,23 +2087,23 @@ "type": "object", "description": "Represents the response for a pending upload request", "properties": { - "blobReferenceForConsumption": { - "$ref": "#/definitions/BlobReferenceForConsumption", + "blobReference": { + "$ref": "#/definitions/BlobReference", "description": "Container-level read, write, list SAS." }, "pendingUploadId": { "type": "string", "description": "ID for this upload request." }, - "datasetVersion": { + "version": { "type": "string", - "description": "Version of dataset to be created if user did not specify version when initially creating upload" + "description": "Version of asset to be created if user did not specify version when initially creating upload" }, "pendingUploadType": { "type": "string", "description": "TemporaryBlobReference is the only supported type", "enum": [ - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "modelAsString": false @@ -2408,7 +2111,7 @@ } }, "required": [ - "blobReferenceForConsumption", + "blobReference", "pendingUploadId", "pendingUploadType" ] @@ -2418,7 +2121,7 @@ "description": "The type of pending upload.", "enum": [ "None", - "TemporaryBlobReference" + "BlobReference" ], "x-ms-enum": { "name": "PendingUploadType", @@ -2430,9 +2133,9 @@ "description": "No pending upload." }, { - "name": "temporaryBlobReference", - "value": "TemporaryBlobReference", - "description": "Temporary Blob Reference is the only supported type." + "name": "BlobReference", + "value": "BlobReference", + "description": "Blob Reference is the only supported type." } ] }